Returns a list of users ID, including user metadata.
Retrieve a list of all users in the company (pod)
Number of users to skip. Default is 0. Must be a integer equals or bigger than 0.
Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000.
Session Authentication token.
400: Bad Request
Client error, see response body for further details.
Unauthorized: Invalid session token.
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.
📘 Note - Suspension
Since 20.14, userSystemInfo from the payload includes suspension info:
if user is active, then the suspended attribute is set to false,
if user is suspended, then the suspended attribute is set to true and both suspendedUntil and suspensionReason are as well included in the payload.
Please note that even if the suspendedUntil date is in the past, the user will remain suspended=true until he first logs on the client after the suspension ended. The suspended info are then automatically updated.
See the Suspend User Account endpoint for more information.
🚧 Required Permissions
Calling this endpoint requires the ACCESS_USER_PROVISIONING_API privilege.
See Bot Permissions for a list of roles and associated privileges.