---
title: "Get Breaks"
method: GET
path: "/{sub_domain}/api/users/breaks"
tags: ["Users"]
---

# Get Breaks

`GET /{sub_domain}/api/users/breaks`

## Request

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

Returns all breaks configured in your account.

**When to use.** Look up the available break types, for example to map break IDs to names when reading break sessions from `GET /users/user-breaks/...`.

**Returns.** `{ "breaks": [ { "id": 2, "name": "...", "dtmf": "...", "is_active": 1, "is_global_default": 0 } ] }`.

## Path parameters

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

## Response `200`

Successful Response

- BreaksResponse
  - `breaks` BreakItem[], required
    - `id` integer, nullable: Break ID.
    - `name` string, nullable: Break name.
    - `dtmf` integer, nullable: Break dedicated DTMF.
    - `is_active` integer, nullable: Break activation state (1/0).
    - `is_global_default` integer, nullable: Whether this is the global default break (1/0).

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