List Agents

Get a list of all Agents.

Headers

X-API-KEYstringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number for pagination.

sizeintegerOptional>=0Defaults to 10

Page size for pagination. Number of Agents to fetch.

namestringOptional

Case-insensitive filter for Agent name.

user_filterstringOptional

Case-insensitive filter for users in the Agent. This filter matches against both email address and name of users.

sort_byenumOptional

Field to sort Agents by

Allowed values:
orderenumOptional

Direction to sort by.

Allowed values:

Response

Successful Response

recordslist of objects
pageinteger
sizeinteger
totalinteger

Errors