---
title: "Get Route Caller IDs"
method: GET
path: "/{sub_domain}/api/route-caller-ids"
tags: ["Route-Caller-IDs"]
---

# Get Route Caller IDs

`GET /{sub_domain}/api/route-caller-ids`

## Request

- Base URL: `https://api.commpeak.com/pbx`
- URL: `https://api.commpeak.com/pbx/{sub_domain}/api/route-caller-ids`
- Auth: API key in header `Authorization`

Returns all route caller IDs available in your account.

**When to use.** List the caller IDs you can assign to outbound routes. To fetch a single record by its ID, use `GET /route-caller-ids/{id}`.

**Parameters.** Filter, order, limit and select fields by any response field.

**Returns.** An envelope with the matching records:

```
{
  "callerIds": [
    {
      "id": 9,
      "caller_id_name": "sales",
      "caller_id_number": "12125551234",
      "created_at": "2023-01-01 00:00:00",
      "is_active": 1
    }
  ]
}
```

**Example.** `GET /api/route-caller-ids`

## Path parameters

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

## Response `200`

Successful Response

- RouteCallerIDsResponse
  - `callerIds` RouteCallerIDItem[], required
    - `id` integer, nullable: Route caller ID.
    - `caller_id_name` string, nullable: Caller ID name.
    - `caller_id_number` string, nullable: Caller ID number.
    - `created_at` string, nullable: Creation timestamp.
    - `is_active` integer, nullable: Enabled flag: 1 = active, 0 = disabled.

## Other responses

- `422`: Validation Error

---

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