GET
/
api
/
v1
/
accounts
/
{account_id}
/
contacts
/
search
Search Contacts
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/contacts/search \
  --header 'api_access_token: <api-key>'
{
  "meta": {
    "count": 123,
    "current_page": "<string>"
  },
  "payload": [
    {
      "additional_attributes": {
        "city": "<string>",
        "country": "<string>",
        "country_code": "<string>",
        "created_at_ip": "<string>"
      },
      "availability_status": "online",
      "email": "<string>",
      "id": 123,
      "name": "<string>",
      "phone_number": "<string>",
      "blocked": true,
      "identifier": "<string>",
      "thumbnail": "<string>",
      "custom_attributes": {},
      "last_activity_at": 123,
      "created_at": 123,
      "contact_inboxes": [
        {
          "source_id": "<string>",
          "inbox": {
            "id": 123,
            "avatar_url": "<string>",
            "channel_id": 123,
            "name": "<string>",
            "channel_type": "<string>",
            "provider": "<string>"
          }
        }
      ]
    }
  ]
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Query Parameters

​
q
string

Search using contact name, identifier, email or phone number

​
sort
enum<string>

The attribute by which list should be sorted

Available options:
name,
email,
phone_number,
last_activity_at,
-name,
-email,
-phone_number,
-last_activity_at
​
page
integer
default:1

The page parameter

Response

Success

​
meta
object
​
payload
object[]

List of contacts