---
title: "List Dynamic Caller ID rules"
method: GET
path: "/dynamic_caller_ids"
tags: ["Dynamic-Caller-IDs"]
---

# List Dynamic Caller ID rules

`GET /dynamic_caller_ids`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/dynamic_caller_ids`
- Auth: API key in header `Authorization`

Returns the customer's Dynamic Caller ID rules. A rule decides which Caller ID is presented for calls of a SIP account: for all destinations (`condition` `any`), a country (`country`, `prefix` is the country dialing code) or a destination prefix (`prefix`), the Caller ID is either passed as sent by the caller (`action` `from`), anonymous (`blocked`) or replaced by `caller_id_number` / `caller_id_name` (`fixed`). Rules with a `fixed` Caller ID that is not verified (`verified` false) can't be assigned to SIP accounts. `sip_accounts` lists the display tokens of the SIP accounts using the rule.

## Response `200`

Successful Response

- DynamicCallerIdsResponse: Envelope returned by `GET /portal/dynamic_caller_ids`.
  - `dynamic_caller_ids` DynamicCallerIdItem[], required
    - `id` integer, required: Rule identifier.
    - `name` string, nullable: Rule name.
    - `condition` string, nullable: Destinations the rule applies to: `any`, `country` or `prefix`.
    - `prefix` string, nullable: Country dialing code or destination prefix (empty for `any`).
    - `action` string, nullable: `from`, `blocked` or `fixed`.
    - `caller_id_number` string, nullable: Caller ID number for `fixed`.
    - `caller_id_name` string, nullable: Caller ID name for `fixed`.
    - `verified` boolean, nullable: False when the `fixed` Caller ID is not verified; such rules can't be assigned to SIP accounts.
    - `sip_accounts` string[], nullable: Display tokens of the SIP accounts using the rule.

---

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