List Users

List the users in your organisation that can be assigned to chats. Use the returned id values as userIds when assigning users to a chat.

The response includes each user's roles and team memberships so you can decide who to assign.

Filtering: platform super-users and hidden/invisible users are excluded. CRM_BOT users are included (they are valid programmatic assignees).

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Responses

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — user lacks CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role

429

Too many requests

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json