Get List of Agents

Retrieve a paginated list of agents in your account. Each agent record includes personal details, contact information, role-specific attributes, group membership, and company association.

Query Params
integer
1 to 500
Defaults to 20

The numbder of items to display per page. The deafult is 20 and you can have up to 500.

integer
≥ 0
Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

string

Query to search by username, first name, last name, email or phone.

expand
array of strings

Include additional related data in the response for the selected entity/entities.

Responses

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