GET
/
api
/
v1
/
accounts
/
{account_id}
/
contacts
/
search
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/contacts/search
{
  "payload": [
    {
      "id": 123,
      "payload": {
        "contact": {
          "email": "<string>",
          "name": "<string>",
          "phone_number": "<string>",
          "thumbnail": "<string>",
          "additional_attributes": {},
          "custom_attributes": {
            "attribute_key": "attribute_value",
            "signed_up_at": "dd/mm/yyyy"
          },
          "contact_inboxes": [
            {
              "source_id": "<string>",
              "inbox": {
                "id": 123,
                "name": "<string>",
                "website_url": "<string>",
                "channel_type": "<string>",
                "avatar_url": "<string>",
                "widget_color": "<string>",
                "website_token": "<string>",
                "enable_auto_assignment": true,
                "web_widget_script": "<string>",
                "welcome_title": "<string>",
                "welcome_tagline": "<string>",
                "greeting_enabled": true,
                "greeting_message": "<string>"
              }
            }
          ]
        }
      }
    }
  ]
}

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

200
application/json
Success

The response is of type object.