List Conversations
Retrieve one page of conversations. Use each conversation's data[].id to read its messages, send a reply or change its status. Open conversations appear first, followed by ordering based on the latest message activity, newest first.
Request
- Base URL: https://developers.chatway.app/api/v1
- URL: https://developers.chatway.app/api/v1/conversations/all
- Auth: API key in header X-API-KEY
Query parameters
Maximum conversations per page. Default: 10. Allowed range: 1–100.
Page number, starting at 1. Default: 1.
Allowed: is_resolved, contact_id, unread_messages, latest_message, contact_name, agents, created_at. Example: contact_name,is_resolved. If both this and exclude_fields are sent, only include_fields is applied.
Allowed: is_resolved, contact_id, unread_messages, latest_message, contact_name, agents, created_at. Ignored when include_fields is also present (include takes precedence).
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 |
New messages can change the conversation order while you read successive pages. Keep track of conversation IDs when importing results. For ongoing message updates, use webhooks rather than repeatedly scanning the conversation list.
Changes
No recorded changes to this operation across all 1 revision of this API.