---
title: "Get keyword contacts"
method: GET
path: "/keywords/{keyword}/contacts"
tags: ["Keywords"]
---

# Get keyword contacts

`GET /keywords/{keyword}/contacts`

REQUIRED SCOPES <code>['keywords:read']</code><br>Get keyword contacts

## Path parameters

- `keyword` string, required

## Query parameters

- `page` integer
- `limit` integer
- `term` string
- `filter` 'subscribed' | 'opted_out'
- `from` string, date, required
- `to` string, date, required

## Response `200`

OK

- ContactResource[]
  - `id` integer — Returns the contact in array format.
  - `owner_id` integer
  - `color` string
  - `first_name` string
  - `last_name` string
  - `full_name` string
  - `email` string
  - `photo_url` string
  - `number` string
  - `country` string
  - `country_calling_code` string
  - `national_number` string
  - `typeted_number` string
  - `is_blocked` boolean
  - `opt_out` boolean
  - `opt_out_at` string
  - `opt_in_request_at` string
  - `opt_in_requests` object[]
    - `number_id` integer
  - `opt_in_at` string
  - `shortcode_opt_outs` object[]
    - `id` integer
    - `number_id` integer
    - `name` string
    - `disabled` boolean
    - `timestamp` string
    - `value` boolean
  - `created_at` string
  - `updated_at` string
  - `integration_vendor_id` integer
  - `prevent_autolink` boolean
  - `integration` object[]
    - `id` integer
    - `key` string
    - `name` string
    - `photo_url` string
  - `custom_fields` ContactCustomFieldResource[]
    - `id` integer
    - `custom_field_id` integer
    - `contact_id` integer
    - `field_key` string
    - `organization_id` integer
    - `text` string
    - `number` integer
    - `date` string
    - `created_at` string
    - `updated_at` string
    - `value` object[]
      - `type` string
      - `value` string
  - `tags` ContactTagResource[]
    - `id` integer
    - `name` string
    - `label` string
    - `created_at` string
  - `notes` object[]
    - `id` integer
    - `text` string
    - `created_at` string
    - `updated_at` string

---

[API](https://skmtc.net/salesmessage/apis/salesmessage-public-api.md) · [All operations](https://skmtc.net/salesmessage/apis/salesmessage-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/salesmessage/salesmessage-public-api/revisions/e96b3e58b041/schema)