List DNC entries for the organization

GET

https://api.smallest.ai/atoms/v1/dnc

GET

/atoms/v1/dnc

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/dnc"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "entries": [
5       {
6         "id": "5f8d0d55b54764421b7156c3",
7         "agentId": "5f8d0d55b54764421b7156a1",
8         "orgId": "5f8d0d55b54764421b715600",
9         "phoneNumber": "+14155552671",
10         "source": "manual_upload",
11         "detectedInCallId": "5f8d0d55b54764421b7156f9",
12         "createdAt": "2024-01-15T09:30:00Z",
13         "updatedAt": "2024-01-15T09:30:00Z"
14       }
15     ],
16     "pagination": {
17       "page": 1,
18       "offset": 50,
19       "total": 125,
20       "totalPages": 3,
21       "hasMore": true
22     }
23   }
24 }

Lists Do-Not-Call entries for the caller’s organization with pagination, search, and sort. Optionally scope to a single agent via agentId.

Each entry records a phone number that was flagged (via call outcome or manual upload) as not-to-be-called for either the org or a specific agent.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

agentIdstringOptional

Optional 24-character hex agent ID. When present, restricts results to entries for this agent. Returns 400/404 if the ID isn’t valid or doesn’t belong to the caller’s org.

searchstringOptional

Free-text search across phone numbers.

sortFieldenumOptionalDefaults to createdAt

Allowed values:

sortOrderenumOptionalDefaults to desc

Allowed values:

pagestringOptionalDefaults to 1

Page number (string-encoded positive integer, ≥ 1).

offsetstringOptionalDefaults to 50

Page size (string-encoded; server clamps to 1–500).

Response

Paginated DNC entries.

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error