List Contacts

List all contacts with values for identifier, email or phone number in your account with pagination (page size = 15).

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/contacts
Method	JSON via GET

Authorization:

Header Parameter	Description
api_access_token	user API key

The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.

Path Parameters:

Parameter	Description	Required
account_id	The numeric id of the account	yes

Query Parameters:

Parameter

type

Description

Required

sort

string

The attribute by which list should be sorted

Enum: "name" "email" "phone_number" "last_activity_at" "-name" "-email" "-phone_number" "-last_activity_at"

page

integer

The page parameter

Default: 1

Response:

{
  "meta": {
    "count": 1,
    "contacts_all": null,
    "current_page": 1
  },
  "payload": [
    {
      "additional_attributes": {},
      "availability_status": "offline",
      "email": "string",
      "id": 0,
      "name": "string",
      "phone_number": "string",
      "identifier": "string",
      "thumbnail": "string",
      "custom_attributes": {
        "attribute_key": "attribute_value"
      },
      "conversations_count": 0,
      "blocked": false,
      "created_at": 0,
      "contact_inboxes": [
        {
          "source_id": "string",
          "inbox": {}
        }
      ]
    }
  ]
}

Response-Explain:

Parameter	Description
meta	Metadata about the contacts
meta -> count	Number of contacts in the account
meta -> contacts_all
meta -> current_page	Current results page
payload	Array of objects (contacts)
payload -> id	Contact numeric id
payload -> name	Full name of the contact
payload -> email	Email address of the contact
payload -> phone_number	Phone number of the contact
payload -> availability_status	Availability status of the contact Enum: `"online"` `"offline"`
payload -> identifier	A unique identifier for the contact in external system
payload -> thumbnail	Avatar URL of the contact
payload -> conversations_count	Contact's number of conversations
payload -> last_activity_at	Timestamp of the last activity
payload -> blocked	Indicates whether the contact is blocked
payload -> created_at	The time at which the contact was created (Unix timestamp)
payload -> custom_attributes	Object containing custom attributes related to the contact
payload -> additional_attributes	Object containing additional attributes related to the contact
payload -> contact_inboxes	Array of objects (contact_inboxes)
payload -> contact_inboxes -> source_id	Contact inbox source id
payload -> contact_inboxes -> inbox	Object containing the inbox details

Created with the Personal Edition of HelpNDoc: Free CHM Help documentation generator