Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Contacts

Retrieves all contacts that match the specified filtering criterion.

As many as all filter parameters and as few as none may be set. Only the dashboard specified will be searched; contacts are organized by dashboard, and there is no account level search for a number available.

get/dashboards/{dashboard_id}/contacts

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

Query parameters

contact_phone_numberstring

The phone number that you're searching for. This uses "starts with" searching.

display_namestring

The display name that you're searching for. This uses "contains substring" searching.

last_message_timestamp_before_utcstring date-time
last_message_timestamp_after_utcstring date-time
contact_created_beforestring date-time
contact_created_afterstring date-time
is_resolvedboolean
has_message_historyboolean
is_blockedboolean
is_archivedboolean
is_suppressedboolean
has_opted_outboolean
last_message_sent_beforestring date-time
last_message_sent_afterstring date-time
last_message_received_beforestring date-time
last_message_received_afterstring date-time
tagsstring

List or singular guid referencing the contact tags you want to filter by

groupsstring

List or singular ids referencing the groups you want to filter by

custom_field_id_1string

Id of custom field to filter by. Requires value for custom_field_value_1 to specify the desired custom field value

custom_field_value_1string

Filter value of the custom field specied in custom_field_id_1. Requires value for custom_field_id_1 to specify which custom field to filter by

custom_field_id_2string

Id of custom field to filter by. Requires value for custom_field_value_2 to specify the desired custom field value

custom_field_value_2string

Filter value of the custom field specied in custom_field_id_2. Requires value for custom_field_id_2 to specify which custom field to filter by

custom_field_id_3string

Id of custom field to filter by. Requires value for custom_field_value_3 to specify the desired custom field value

custom_field_value_3string

Filter value of the custom field specied in custom_field_id_3. Requires value for custom_field_id_3 to specify which custom field to filter by

pageinteger

The page number. The first item returned will be page multiplied by page_size

page_sizeinteger

The number of items returned. The first item returned will be page multiplied by page_size

Response

A list of contacts.

Example response

{
  "meta": {
    "total_items": 172
  },
  "items": [
    {
      "phone_number": "13216547890",
      "first_name": "John",
      "last_name": "Smith",
      "display_name": "John Smith",
      "thread_id": "166382ad-72ce-466a-bc64-ce5247905e43",
      "suppressed_reason": "Contact asked not to be texted.",
      "note": "Lead from newsletter",
      "groups": [
        12,
        26
      ],
      "contact_tags": [
        "a8608167-caf8-485c-a0c5-d97fb0fc9069",
        "54b35406-189d-4e70-a170-c87e231f8ca3"
      ],
      "custom_fields": [
        {
          "id": "cc63eb7d-3575-478f-b42e-1e64e40d41c9",
          "value": "john.doe@gmail.com"
        }
      ]
    }
  ]
}