contacts_list_response

meta object

countinteger

Total number of contacts

current_pagestring | integer

Current page number

payload object[]

List of contacts

Array [

additional_attributes object

The object containing additional attributes related to the contact

citystring

City of the contact

countrystring

Country of the contact

country_codestring | nullnullable

Country code of the contact

created_at_ipstring

IP address when the contact was created

availability_statusstring

Availability status of the contact

Possible values: [online, offline]

emailstring | nullnullable

The email address of the contact

idinteger

The ID of the contact

namestring

The name of the contact

phone_numberstring | nullnullable

The phone number of the contact

blockedboolean

Whether the contact is blocked

identifierstring | nullnullable

The identifier of the contact

thumbnailstring

The thumbnail of the contact

custom_attributesobject

The custom attributes of the contact

last_activity_atinteger | nullnullable

Timestamp of last activity

created_atinteger

Timestamp when contact was created

contact_inboxes object[]

List of inboxes associated with this contact

Array [

source_idstring

Source identifier for the contact inbox

inbox object

idinteger

ID of the inbox

avatar_urlstring

URL for the inbox avatar

channel_idinteger

ID of the channel

namestring

Name of the inbox

channel_typestring

Type of channel

providerstring | nullnullable

Provider of the inbox

]

]

contacts_list_response

{
  "meta": {
    "count": 0,
    "current_page": "string"
  },
  "payload": [
    {
      "additional_attributes": {
        "city": "string",
        "country": "string",
        "country_code": "string",
        "created_at_ip": "string"
      },
      "availability_status": "online",
      "email": "string",
      "id": 0,
      "name": "string",
      "phone_number": "string",
      "blocked": true,
      "identifier": "string",
      "thumbnail": "string",
      "custom_attributes": {},
      "last_activity_at": 0,
      "created_at": 0,
      "contact_inboxes": [
        {
          "source_id": "string",
          "inbox": {
            "id": 0,
            "avatar_url": "string",
            "channel_id": 0,
            "name": "string",
            "channel_type": "string",
            "provider": "string"
          }
        }
      ]
    }
  ]
}