List Agents under the current account with cursor pagination.
See Pagination for cursor semantics.
HTTP 200 OK
Page forward (next page):
See Errors for the full error envelope.
GET /api/v1/cloud/agents
Lists Agents under the current account. Archived Agents are excluded unless include_archived=true is provided.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | 20 | Items per page. Range 1-100; values above 100 return 400 invalid_request_error |
page | string | No | - | Cursor returned by the previous response's next_page |
include_archived | boolean | No | false | Set to true to include archived Agents |
created_at[gte] | string | No | - | Include Agents created at or after this RFC 3339 timestamp |
created_at[lte] | string | No | - | Include Agents created at or before this RFC 3339 timestamp |
Example request
Example response
HTTP 200 OK
Response fields
Field | Type | Description |
| array of Agent object | Agents on the current page |
| string | ID of the first record on this page |
| string | ID of the last record on this page |
| boolean | Whether more records remain |
| string|null | Cursor for the next page. Equals |
Pagination
Page forward (next page):
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | limit is not a positive integer |
| 400 | invalid_request_error | Invalid pagination cursor |
| 400 | invalid_request_error | created_at[gte] or created_at[lte] is not RFC 3339 |
| 401 | authentication_error | PAT invalid or expired |
| 403 | permission_error | Not authorized for this operation |
Notes
- Records are returned in descending ID order by default.
- Archived Agents do not appear in the default listing. Pass
include_archived=trueto include them. - Pagination is cursor-based; offset-based pagination is not supported.