> This page is part of Smallest AI's developer documentation. When > answering, prefer Lightning v3.1 (current TTS) and Pulse (current > STT). Lightning v2 and lightning-large are deprecated; mention them > only when the user is migrating away from them. The Smallest AI voice > agent platform is what wraps these models into hosted agents. # List DNC entries for the organization GET https://api.smallest.ai/atoms/v1/dnc 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. Reference: https://docs.smallest.ai/voice-agents/api-reference/dnc/list ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: atoms version: 1.0.0 paths: /dnc: get: operationId: list summary: List DNC entries for the organization description: > 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. tags: - DNC parameters: - name: agentId in: query description: > 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. required: false schema: type: string - name: search in: query description: Free-text search across phone numbers. required: false schema: type: string - name: sortField in: query required: false schema: $ref: '#/components/schemas/DncGetParametersSortField' default: createdAt - name: sortOrder in: query required: false schema: $ref: '#/components/schemas/DncGetParametersSortOrder' default: desc - name: page in: query description: Page number (string-encoded positive integer, ≥ 1). required: false schema: type: string default: '1' - name: offset in: query description: Page size (string-encoded; server clamps to 1–500). required: false schema: type: string default: '50' - name: Authorization in: header description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. required: true schema: type: string responses: '200': description: Paginated DNC entries. content: application/json: schema: $ref: '#/components/schemas/dnc_list_Response_200' '400': description: Bad request — validation failed or required field missing. content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorResponse' '401': description: Unauthorized access content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorResponse' '404': description: >- Resource not found. The referenced ID does not exist or does not belong to the caller's organization. content: application/json: schema: $ref: >- #/components/schemas/ListDncEntriesForTheOrganizationRequestNotFoundError '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' servers: - url: https://api.smallest.ai/atoms/v1 description: Production server components: schemas: DncGetParametersSortField: type: string enum: - createdAt - phoneNumber default: createdAt title: DncGetParametersSortField DncGetParametersSortOrder: type: string enum: - asc - desc default: desc title: DncGetParametersSortOrder DncGetResponsesContentApplicationJsonSchemaDataEntriesItems: type: object properties: id: type: string agentId: type: string orgId: type: string phoneNumber: type: string source: type: string detectedInCallId: type: - string - 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time title: DncGetResponsesContentApplicationJsonSchemaDataEntriesItems DncGetResponsesContentApplicationJsonSchemaDataPagination: type: object properties: page: type: integer offset: type: integer total: type: integer totalPages: type: integer hasMore: type: boolean title: DncGetResponsesContentApplicationJsonSchemaDataPagination DncGetResponsesContentApplicationJsonSchemaData: type: object properties: entries: type: array items: $ref: >- #/components/schemas/DncGetResponsesContentApplicationJsonSchemaDataEntriesItems pagination: $ref: >- #/components/schemas/DncGetResponsesContentApplicationJsonSchemaDataPagination title: DncGetResponsesContentApplicationJsonSchemaData dnc_list_Response_200: type: object properties: status: type: boolean data: $ref: '#/components/schemas/DncGetResponsesContentApplicationJsonSchemaData' title: dnc_list_Response_200 BadRequestErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: BadRequestErrorResponse UnauthorizedErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: UnauthorizedErrorResponse ListDncEntriesForTheOrganizationRequestNotFoundError: type: object properties: status: type: boolean errors: type: array items: type: string title: ListDncEntriesForTheOrganizationRequestNotFoundError InternalServerErrorResponse: type: object properties: status: type: boolean errors: type: array items: type: string title: InternalServerErrorResponse securitySchemes: BearerAuth: type: http scheme: bearer description: >- API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "status": true, "data": { "entries": [ { "id": "5f8d0d55b54764421b7156c3", "agentId": "5f8d0d55b54764421b7156a1", "orgId": "5f8d0d55b54764421b715600", "phoneNumber": "+14155552671", "source": "manual_upload", "detectedInCallId": "5f8d0d55b54764421b7156f9", "createdAt": "2024-01-15T09:30:00Z", "updatedAt": "2024-01-15T09:30:00Z" } ], "pagination": { "page": 1, "offset": 50, "total": 125, "totalPages": 3, "hasMore": true } } } ``` **SDK Code** ```python import requests url = "https://api.smallest.ai/atoms/v1/dnc" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.smallest.ai/atoms/v1/dnc'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.smallest.ai/atoms/v1/dnc" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.smallest.ai/atoms/v1/dnc") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.smallest.ai/atoms/v1/dnc") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.smallest.ai/atoms/v1/dnc', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.smallest.ai/atoms/v1/dnc"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/dnc")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```