---
title: "List Do Not Call entries"
method: GET
path: "/do-not-call"
tags: ["Do Not Call"]
---

# List Do Not Call entries

`GET /do-not-call`

## Request

- Base URL: `https://vocenya.com/api/public/v1`
- URL: `https://vocenya.com/api/public/v1/do-not-call`
- Auth: HTTP bearer

Your Do Not Call list, newest first. Pass `phone_number` to look up one number.

## Query parameters

- `phone_number` string
- `source` 'opt_out' | 'manual'
- `per_page` integer
- `cursor` string, nullable

## Response `200`

Paginated set of `DoNotCallEntryResource`

- object
  - `data` DoNotCallEntryResource[], required
    - `id` integer, required
    - `livemode` boolean, required: `true` for live data, `false` for test data (created with a `vk_test_` key).
    - `phone_number` string, required
    - `source` 'opt_out' | 'manual' | 'national_registry', required: | | |---| | `opt_out` <br/> The person asked not to be called: on an AI call, to a GH Live agent, or to the client. | | `manual` <br/> Added by GH staff or the client. | | `national_registry` <br/> Imported from the FTC National Do Not Call Registry. |
    - `note` string, nullable, required
    - `removable` boolean, required: Whether the entry can be removed. People who asked not to be called never can.
    - `created_at` string, nullable, required
  - `links` object, required
    - `first` string, nullable, required
    - `last` string, nullable, required
    - `prev` string, nullable, required
    - `next` string, nullable, required
  - `meta` object, required
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `next_cursor` string, nullable, required: The "cursor" that points to the next set of items.
    - `prev_cursor` string, nullable, required: The "cursor" that points to the previous set of items.

## Other responses

- `401`: The API key is missing, invalid, expired or revoked.
- `403`: The key does not have the `dnc:read` scope.
- `422`: Validation error
- `429`: Too many requests for this key. Wait for the `Retry-After` seconds.

---

[API](https://skmtc.dev/vocenya/apis/vocenya-api.md) · [All operations](https://skmtc.dev/vocenya/apis/vocenya-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocenya/apis/vocenya-api/revisions/946913941565?raw)