Agents
Agent
List Agents
List the agents available to your API key. Use an agent's data[].id when another operation asks for agent_id. Results are paginated: the default is 20 agents per page, with a maximum of 100.
get/agents
Request
- Base URL: https://developers.chatway.app/api/v1
- URL: https://developers.chatway.app/api/v1/agents
- Auth: API key in header X-API-KEY
Query parameters
emailstring email nullable
Optional email filter. Omit it to request the list without an email filter.
limitinteger nullable
Maximum agents per page. Default: 20. Allowed range: 1–100.
pageinteger nullable
Page number, starting at 1. Default: 1.
Response
Paginated list responses include data, meta.pagination, and links. Use the page and limit query parameters to walk results. Follow links.next until it is null, or increment page until current_page >= total_pages.
| Field | Description |
|---|---|
| meta.pagination.total | Total records across all pages |
| meta.pagination.count | Records returned on this page |
| meta.pagination.per_page | Page size used for this response (matches limit) |
| meta.pagination.current_page | Current page number (1-based) |
| meta.pagination.total_pages | Total number of pages |
| links.next | URL for the next page, or null on the last page |
| links.first / links.last | First and last page URLs |
Changes
No recorded changes to this operation across all 1 revision of this API.