cURL
curl --request POST \ --url https://api.velt.dev/v1/users/get \ --header 'Content-Type: application/json' \ --header 'x-velt-api-key: <x-velt-api-key>' \ --header 'x-velt-auth-token: <x-velt-auth-token>' \ --data '{ "data": { "organizationId": "<string>", "documentId": "<string>", "userIds": [ "<string>" ], "organizationUserGroupIds": [ "<string>" ] } }'
{ "result": { "status": "success", "message": "User(s) retrieved successfully.", "data": [ { "email": "userEmail@domain.com", "name": "userName", "userId": "yourUserId" } ] } }
POST https://api.velt.dev/v1/users/get
Show properties
{ "data": { "organizationId": "yourOrganizationId" } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId" } }
{ "data": { "organizationId": "yourOrganizationId", "userIds": [ "yourUserId1", "yourUserId2" ] } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "userIds": [ "yourUserId1", "yourUserId2" ] } }
{ "data": { "organizationId": "yourOrganizationId", "organizationUserGroupIds": [ "yourOrganizationUserGroupId" ] } }
{ "data": { "organizationId": "yourOrganizationId", "userIds": [ "yourUserId1", "yourUserId2" ], "organizationUserGroupIds": [ "yourOrganizationUserGroupId" ] } }
{ "error": { "message": "Error retrieving user(s).", "status": "ERROR_CODE" } }
Was this page helpful?