logo
DNCList DNC entries

List DNC entries

Returns a paginated list of Do Not Contact entries for the workspace. Optionally filter by entry type.

curl -X GET "https://api.sendkit.ai/v1/dnc?type=email&cursor=664a1b2c3d4e5f6a7b8c9d0e&limit=42" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": [
    {
      "_id": "664a1b2c3d4e5f6a7b8c9d0e",
      "email": "unsubscribed@example.com",
      "entryType": "email",
      "workspaceId": "ws_123",
      "reason": "manual",
      "unsubscribedAt": "2024-06-01T10:00:00.000Z",
      "createdAt": "2024-06-01T10:00:00.000Z",
      "updatedAt": "2024-06-01T10:00:00.000Z"
    },
    {
      "_id": "664a1b2c3d4e5f6a7b8c9d0f",
      "email": "spamtrap.com",
      "entryType": "domain",
      "workspaceId": "ws_123",
      "reason": "manual",
      "unsubscribedAt": "2024-06-01T10:05:00.000Z",
      "createdAt": "2024-06-01T10:05:00.000Z",
      "updatedAt": "2024-06-01T10:05:00.000Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "total": 45,
    "hasMore": true,
    "nextCursor": "664a1b2c3d4e5f6a7b8c9d0f"
  }
}
GET
/v1/dnc
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
query
typestring

Filter by entry type.

Options: email, domain
query
cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

query
limitinteger

Items per page (default 25, max 100)

Min: 1 • Max: 100
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Query Parameters

typestring

Filter by entry type.

Allowed values:emaildomain
cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

limitinteger

Items per page (default 25, max 100)

Responses

successboolean
dataarray
paginationobject