---
title: "List do-not-contact entries"
method: GET
path: "/do-not-contact/"
tags: ["suppression"]
---

# List do-not-contact entries

`GET /do-not-contact/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/do-not-contact/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

One page of the list, newest first unless `order_by` says otherwise: `created_at` orders by when each entry was added, `value` by the address or domain. Ties go by id, so paging with `offset` never repeats or skips an entry.

## Query parameters

- `search` string, nullable
- `kind` 'email' | 'domain': Whether an entry blocks one address or a whole domain.
- `order_by` 'created_at' | 'value'
- `order_direction` 'asc' | 'desc'
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- SuppressionPageSchema
  - `items` SuppressionEntryReadSchema[], required
    - `created_at` string, date-time, required
    - `id` string, uuid, required
    - `kind` 'email' | 'domain', required: Whether an entry blocks one address or a whole domain.
    - `source` 'manual' | 'opt_out_reply' | 'inbox_action' | 'opt_out_link' | 'hard_bounce', required: How an entry got onto the list, kept for audit and for the UI's story.
    - `value` string, required
  - `total` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

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