Filter contacts | Hams AI Docs

curl -X POST https://omni-channel.hams.ai/api/v1/accounts/1/developer/contacts/filter \
     -H "api_access_token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "payload": [
    {
      "attribute_key": "phone_number",
      "filter_operator": "equal_to",
      "values": [
        "+971500000000"
      ]
    }
  ]
}'

{
  "meta": {
    "count": 1,
    "current_page": 1
  },
  "payload": [
    {
      "id": 1,
      "name": "string",
      "email": "string",
      "phone_number": "string",
      "identifier": "string",
      "blocked": true,
      "availability_status": "string",
      "thumbnail": "string",
      "custom_attributes": {},
      "additional_attributes": {},
      "last_activity_at": 1,
      "created_at": 1,
      "contact_inboxes": [
        {}
      ]
    }
  ]
}

Finds contacts that match a list of conditions. Each item in payload is 1 condition. query_operator joins the item to the next item. Leave it out on the last item. The result has 20 contacts on each page.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

Query parameters

pageintegerOptionalDefaults to 1

The page number. The first page is 1.

Request

This endpoint expects an object.

payloadlist of objectsRequired

Response

The contacts that match.

metaobjectOptional

payloadlist of objectsOptional

Errors

401

Unauthorized Error

422

Unprocessable Entity Error