POST
/

Use this API to retrieve users based on various filters such as organization ID, document ID, organization user group IDs or user IDs. You can use these filters in various combinations to get the desired users. Some examples are shown below.

​
Endpoint

POST https://getusers.api.velt.dev/

​
Headers

x-velt-api-key
string
required

Your API key.

x-velt-auth-token
string
required

Your Auth Token.

​
Body Example

​
Params

data
object
required

​
Example Requests

​
1. Get users by organizationId

{
  "data": {
    "organizationId": "yourOrganizationId"
  }
}

​
2. Get users by documentId within an organization

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId"
  }
}

​
3. Get users by specific user IDs in an organization

{
  "data": {
    "organizationId": "yourOrganizationId",
    "userIds": [
      "yourUserId1",
      "yourUserId2"
    ]
  }
}

​
4. Get users by specific user IDs in the given organization and document

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "userIds": [
      "yourUserId1",
      "yourUserId2"
    ]
  }
}

​
5. Get users by organization and organization user group IDs

{
  "data": {
    "organizationId": "org10",
    "organizationUserGroupIds": [
      "mayankevenGroup"
    ]
  }
}

​
6. Get users by organization, organization user group IDs and user IDs

{
  "data": {
    "organizationId": "org10",
    "userIds": [
      "user20",
      "vivekuser3"
    ],
    "organizationUserGroupIds": [
      "mayankevenGroup"
    ]
  }
}

​
Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "User(s) retrieved successfully.",
    "data": [
      {
        "email": "mayank+user+doc+1@snippyly.com",
        "name": "Mayank doc User 1 Updated",
        "userId": "mayankuserdoc1"
      }
    ]
  }
}

​
Failure Response

{
  "error": {
    "message": "Error retrieving user(s).",
    "status": "ERROR_CODE"
  }
}

Was this page helpful?

Delete All User Data (GDPR)Add User Groups