Skip to main content
POST
/
users
/
get
Get Users
curl --request POST \
  --url https://api.velt.dev/v2/users/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <api-key>' \
  --header 'x-velt-auth-token: <api-key>' \
  --data '{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "folderId": "<string>",
    "userIds": [
      "<string>"
    ],
    "organizationUserGroupIds": [
      "<string>"
    ],
    "allDocuments": true,
    "groupByDocumentId": true,
    "pageSize": 1000,
    "pageToken": "<string>"
  }
}'
{
  "result": {
    "status": "<string>",
    "message": "<string>",
    "data": [
      {
        "userId": "yourUserId1",
        "name": "User Name",
        "email": "user@email.com",
        "accessRole": "editor",
        "initial": "UN"
      }
    ],
    "nextPageToken": "<string>"
  }
}

Authorizations

​
x-velt-api-key
string
header
required

Your API key from the Velt Console

​
x-velt-auth-token
string
header
required

Your Auth Token for authentication

Body

application/json
​
data
object
required

Response

Users retrieved successfully

​
result
object