---
title: "Get all dynamic caller ids"
method: GET
path: "/{sub_domain}/api/did"
tags: ["DIDs"]
---

# Get all dynamic caller ids

`GET /{sub_domain}/api/did`

## Request

- Base URL: `https://api.commpeak.com/dialer`
- URL: `https://api.commpeak.com/dialer/{sub_domain}/api/did`
- Auth: API key in header `Authorization`

Retrieve the full list of dynamic caller IDs in your account.

**When to use.** Browse or export your dynamic caller IDs, or look up a caller ID's `id`, number and active status before enabling or disabling it. To retrieve only the caller IDs that match a filter, use `GET /did/campaign_id/{filterby}`.

**Parameters.** Use the `fields` query parameter with a semicolon-separated list to return only the fields you need, for example `caller_id_number;caller_id_name;is_active`. Include `prefixes` in that list to also return the dialing prefixes associated with each caller ID, which are omitted by default.

**Returns.** `{ "dynamicCallerIds": [ ... ], "total_did": N }`.

**Example.** `GET /api/did/fields/caller_id_number;caller_id_name;is_active;prefixes`

## Path parameters

- `sub_domain` string, required: Dialer Name (subdomain)

## Response `200`

Successful Response

- DynamicCallerIDsResponse
  - `dynamicCallerIds` DynamicCallerIDItem[], required
    - `id` integer, nullable: Dynamic caller id ID.
    - `campaign_id` integer, nullable
    - `caller_id_number` string, nullable: Caller ID number.
    - `caller_id_name` string, nullable: Caller ID name.
    - `is_active` integer, nullable: Whether the caller id is active (0 or 1).
    - `parent_id` integer, nullable: Parent dynamic caller id ID, if any.
    - `is_blocked` integer, nullable: Whether the caller id is blocked (0 or 1).
    - `created_at` object, nullable: Creation timestamp.
    - `prefixes` object[], nullable: Prefixes associated with the dynamic caller id.
  - `total_did` integer, nullable: Total number of dynamic caller ids in the response.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)