---
title: "Retrieves all contacts that match the specified filtering criterion."
method: GET
path: "/dashboards/{dashboard_id}/contacts"
tags: ["Contacts"]
---

# Retrieves all contacts that match the specified filtering criterion.

`GET /dashboards/{dashboard_id}/contacts`

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.

## Path parameters

- `dashboard_id` integer, required

## Query parameters

- `contact_phone_number` string
- `display_name` string
- `last_message_timestamp_before_utc` string, date-time
- `last_message_timestamp_after_utc` string, date-time
- `contact_created_before` string, date-time
- `contact_created_after` string, date-time
- `is_resolved` boolean
- `has_message_history` boolean
- `is_blocked` boolean
- `is_archived` boolean
- `is_suppressed` boolean
- `has_opted_out` boolean
- `last_message_sent_before` string, date-time
- `last_message_sent_after` string, date-time
- `last_message_received_before` string, date-time
- `last_message_received_after` string, date-time
- `tags` string
- `groups` string
- `custom_field_id_1` string
- `custom_field_value_1` string
- `custom_field_id_2` string
- `custom_field_value_2` string
- `custom_field_id_3` string
- `custom_field_value_3` string
- `page` integer
- `page_size` integer

## Response `200`

A list of contacts.

- ContactResponseContainer
  - `meta` PaginationInfo
    - `page` integer — The current page of this get request
    - `page_size` integer — The current page-size of this get request
    - `total_items` integer — The total number of queryable items
  - `items` Contact[]
    - `phone_number` string — The contact's phone number.
    - `first_name` string — The contact's first name.
    - `last_name` string — The contact's last name.
    - `display_name` string — The contact's display name.
    - `thread_id` string — The id of the thread for this contact's conversation on this dashboard. To access the thread of this contact in the webapp, go to https://app.textrequest.com/app/thread/<thread_id>
    - `is_suppressed` boolean — Whether the contact is suppressed.
    - `is_archived` boolean — Whether the contact is archived.
    - `is_blocked` boolean — Whether the contact is blocked.
    - `suppressed_reason` string — For notekeeping, a reason why the contact was suppressed.
    - `note` string — Any text notes for the contact.
    - `groups` integer[] — An array of group identifiers that reference group membership.
    - `contact_tags` string[] — An array of the contact's tags.
    - `custom_fields` CustomFieldEntry[] — An array of the contact's custom field values.
      - `id` string — The custom field's guid you can use to edit the value.
      - `value` string — Current value of the custom field.
    - `is_resolved` boolean — Whether or not their conversation thread is currently resolved.
    - `first_contact_utc` string — When the contact was first messaged. All dates are UTC.
    - `opted_out_utc` string — When the contact opted out. Null if the contact has not and can receive messages.
    - `last_msg_sent_utc` string, date-time — When the contact was last sent a message.
    - `last_msg_received_utc` string, date-time — When this dashboard last received a message from a contact.
    - `total_msgs_sent` integer — Total messages sent to a contact.
    - `total_msgs_received` integer — Total messages received from a contact.
    - `response_count` integer — Total number of response messages from the contact.
    - `date_created_utc` string, date-time — When the contact was created.
    - `last_contact_date_utc` string, date-time — When the contact was last contacted.
    - `last_message` object — Last message sent to or from this contact.

## Other responses

- `400` — Bad request. Sent if a query is invalid.
- `401` — Unauthorized. Sent if the API key is omitted or invalid.

---

[API](https://skmtc.net/textrequest/apis/text-request-api-v3.md) · [All operations](https://skmtc.net/textrequest/apis/text-request-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textrequest/text-request-api-v3/revisions/e4e42efcd650/schema)