Skip to main content
GET
List Agents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

agent_id
string<uuid4>[] | null
workspace_id
string<uuid4>[] | null
status
enum<string>[] | null
Available options:
ACTIVE,
ARCHIVED
skip
integer
default:0
Required range: x >= 0
limit
integer
default:100
Required range: 1 <= x <= 100
expand
string[] | null

total_count: Include the total number of agents that match the query, only accurate up to 100.

Allowed value: "total_count"

Response

Successful Response

data
Agent · object[]
required
hasMore
boolean
default:false

Whether there are more agents that match the query that were not included in this response.

totalCount
integer | null

The total number of agents that match the query, only accurate up to 100.