APIAgents
List agents
List all agent instances in the organization.
GET
/agent-instancesList all agent instances in the organization.
Query Parameters
offset?integer
Number of items to skip before returning results.
Format
int32Range
0 <= valueDefault
0limit?integer
Maximum number of items to return per page.
Format
int32Range
0 <= value <= 20Default
10search?string
Free-text search term to filter results by name.
Length
length <= 255agent_slug?array<string>
user_id?array<>
sort_by?string
Default
"created_at"Value in
- "created_at"
- "display_name"
- "last_used_at"
sort_order?string
Default
"desc"Value in
- "asc"
- "desc"
Response Body
application/json
application/json
curl -X GET "https://example.com/agent-instances"{ "items": [ { "id": null, "user_id": null, "user_display_name": "string", "display_name": "string", "metadata": { "client_name": "string", "client_version": "string", "protocol_version": "string", "user_agent": "string", "ip_address": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "revoked_at": "2019-08-24T14:15:22Z", "agent_slug": "string", "external_id": "string" } ], "meta": { "total": 0, "offset": 0, "limit": 0 }}{ "code": "bad_request", "message": "string", "validation_errors": [ { "field": "string", "message": "string", "rule": "string" } ]}