---
title: "Get all CDRs"
method: GET
path: "/{sub_domain}/api/cdrs"
tags: ["CDRs"]
---

# Get all CDRs

`GET /{sub_domain}/api/cdrs`

## Request

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

Retrieve the detailed call records that power the Call Analytics report.

**When to use.** Pull the individual call rows behind Call Analytics for reporting, audits, or reconciliation against your own systems. For per-period aggregates (totals, ACD, ASR) rather than individual rows, use `POST /cdrs/cdrs-aggregate`.

**Filtering and shape.** Filter, order, limit and select fields by any response field. See [Core API Concepts](https://td.commpeak.link/ReadMe-PBX-api-docs). Use `fields` with a semicolon-separated list to limit the returned columns. Common filters include `caller_user_id`, `start_at` and `end_at`, `dst`, `dst_country` and `network_type`. The response is wrapped as `{ "cdrs": [ ... ] }`, and is an empty array when nothing matches.

**Example.** `GET /api/cdrs/start_at/2020-09-01 00:00:00/limit/50;0`

Gateway note: custom call fields defined on the account can be used as filter keys (path segments, see the `_filtered` variant) and are returned on each record alongside the standard fields.

## Path parameters

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

## Response `200`

Successful Response

- CDRsResponse
  - `cdrs` CDRItem[], required
    - `start_at` string, nullable: Call start time.
    - `end_at` string, nullable: Call end time.
    - `src` string, nullable: Source (agent SIP URI).
    - `dst` string, nullable: Destination number.
    - `call_uuid` string, nullable: Unique call UUID.
    - `client_callerid_name` string, nullable: Caller ID name.
    - `client_callerid_number` string, nullable: Caller ID number.
    - `call_duration` integer, nullable: Call duration in seconds.
    - `cost` number, nullable: CDR rate cost.
    - `status` string, nullable: Hangup cause of the call.
    - `q850` integer, nullable: Q.850 hangup cause code.

## 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)
