---
title: "Read Dialer Preferences"
method: GET
path: "/dialer/settings/preferences/{user_email}"
tags: ["Dialer"]
---

# Read Dialer Preferences

`GET /dialer/settings/preferences/{user_email}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/dialer/settings/preferences/{user_email}`
- Auth: HTTP bearer

CONTACTS NOBODY. One rep's dialer preferences.

The app's path is `/preferences/{org_id}/{user_email}` and its handler
reads whichever organisation the path names. The org segment is NOT
published - it comes from the key - so this cannot read another tenant's
configuration.

Voice additionally refuses to read a rep other than the authenticated one
(`dialer_settings.py:23-41`). An organisation API key is not a rep, so it
supplies the rep the caller named: the tenant boundary holds, the
rep-versus-rep boundary does not apply to an org credential.

## Path parameters

- `user_email` string, required: The rep whose preferences to read.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseDialerPayload
  - `data` DialerPayload, required: An open envelope for one dialer result. Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)