API Reference
Privacy & SecuritySupport CenterLog In

List Users

get
https://api.regal.ai/v1/users

Retrieve a list of your users.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed these limits, you will receive a 429 Rate Limit Exceeded response.

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.

Query Params
string

Cursor returned from the previous response.

number

Number of results per page. Defaults to 25. Maximum 100.

string

Case-insensitive email substring filter.

string

URL-encoded JSON array of skill names. User must have all listed skills.

string

URL-encoded JSON array of team names. User must belong to at least one listed team.

string

URL-encoded JSON array of queue names. User must be eligible for at least one listed queue.

string

URL-encoded JSON object of custom attribute key-value filters. Values may be strings, numbers, booleans, or null.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Invalid query parameters, unknown team, or unknown queue.

Updated about 2 months ago

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

Updated about 2 months ago

Did this page help you?