v1

latestOpenAPI 3.0.32026-08-06128539552.6 KB
Agents

List agents

Lists all agents/admins in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.

get/beta/agents

Query parameters

pageLimitinteger

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

emailstring

The agent/admin email filter

phonestring

The agent/admin phone number filter

Response

The list of agents/admins