List Chat Contacts
List visitor contacts and obtain the IDs needed for Get Chat Contact, Update Chat Contact and Create Visitor Message. Each contact's ID is in data[].id. The default page contains up to 10 contacts; the maximum page size is 100.
To keep the response focused, use include_fields with the attributes you need. For example, include_fields=name,email,widget_id selects those contact attributes. The allowed names appear below. If you supply both include_fields and exclude_fields, only include_fields is applied.
Request
- Base URL: https://developers.chatway.app/api/v1
- URL: https://developers.chatway.app/api/v1/contacts
- Auth: API key in header X-API-KEY
Query parameters
Optional contact search term. Omit it to list contacts without a search filter.
Maximum contacts per page. Default: 10. Allowed range: 1–100.
Page number, starting at 1. Default: 1.
Allowed: widget_name, widget_id, team_id, name, email, phone, country_dialing_code, bgcolor, location, browser_type, country_code, country, country_flag, country_emoji, page_visited, online_status, last_active_at, blocked_at, is_name_updated, created_at, verified_id, verified_email, timezone, language, ip, operating_system. Example: name,widget_name. If both this and exclude_fields are sent, only include_fields is applied.
Allowed: widget_name, widget_id, team_id, name, email, phone, country_dialing_code, bgcolor, location, browser_type, country_code, country, country_flag, country_emoji, page_visited, online_status, last_active_at, blocked_at, is_name_updated, created_at, verified_id, verified_email, timezone, language, ip, operating_system. 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 |
Changes
No recorded changes to this operation across all 1 revision of this API.