List Users

API Details

  • Returns active users (including human and AI agents) for the authenticated brand.
  • Results are ordered by Regal user ID. Use nextCursor from the response to retrieve the next set of results.
  • Filters combine with AND across email, skills, teams, queues, and custom attributes.
  • Multiple queue values are treated as OR: users eligible for any listed queue are returned.
  • skills, teams, queues, and customAttributes must be JSON-encoded query string values.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Query Params
string
length ≥ 1
integer
1 to 100
string
length ≥ 1
string | array

Skill names (URL-encoded JSON array of strings)

string | array

Team names (URL-encoded JSON array of strings)

string | array

Queue names (URL-encoded JSON array of strings)

string | object

JSON object mapping attribute names to filter values

Responses

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