List agents

Returns a list of your agents and their metadata.

Headers

xi-api-keystringRequired

Query Parameters

page_sizeintegerOptional1-100Defaults to 30
How many Agents to return at maximum. Can not exceed 100, defaults to 30.
searchstring or nullOptional
Search by agents name.
archivedboolean or nullOptionalDefaults to false
Filter agents by archived status
sort_directionenumOptional
The direction to sort the results
Allowed values:
sort_byenumOptional
The field to sort the results by
Allowed values:
cursorstring or nullOptional
Used for fetching next page. Cursor is returned in the response.

Response

Successful Response
agentslist of objects
A list of agents and their metadata
has_moreboolean
Whether there are more agents to paginate through
next_cursorstring or null
The next cursor to paginate through the agents

Errors