List agents
GET/agents
Returns one page of the agents that the key can read, in the list envelope. Query parameters filter the list by field values and set the order and the page.
Permissions. Read on the agents in the list. The list contains only the agents that the key can read, so a key without read permission on any agent receives an empty list.
API conventions describes pagination, filters and ordering.
Request
Responses
- 200
- 400
- 401
One page of agents. data holds the agents, page_info describes the page and query_info repeats the filters that the server recognized.
order_by names a field that the list cannot sort by (Invalid order_by parameter), or the pagination parameters conflict or carry an invalid cursor (Pagination error).
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.