DNC

List DNC entries for the organization

Changed on

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.

get/dnc

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/dnc
  • Auth
    HTTP bearer

Query parameters

agentIdstring

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.

searchstring

Free-text search across phone numbers.

sortField'createdAt' | 'phoneNumber'
sortOrder'asc' | 'desc'
pagestring

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

offsetstring

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

Response

Paginated DNC entries.

statusboolean

Example response

{
  "status": true
}

Changes