Get Agents

Get agents with global search or specific filters.
If search is provided, it takes priority over filters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a paged list of agents. A search value searches across fields and takes priority over the specific filters.

When to use it

Use it to find an agent's ID before you call an agent-specific endpoint, or to build an inventory of your agents. Set only_archived to true to list archived agents only.

Required parameters

This call takes no required parameters.

Optional query parameters: only_archived, search, name, created_by, dataset_id. Use page and size to page through the results.

Response

A successful call returns 200 OK with a page of Agent objects in items, plus the paging fields total, page, size, and pages.

Related: Get an agent, Create an agent, Archive an agent

Query Params
boolean
Defaults to false
integer
≥ 1
Defaults to 1

Page number

integer
25 to 1000
Defaults to 25
Responses

422

Unprocessable Entity

500

Internal Server Error

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