---
title: "Get phone book"
method: GET
path: "/v1/phone-book"
tags: ["Owner"]
---

# Get phone book

`GET /v1/phone-book`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/phone-book`
- Auth: HTTP bearer

## Query parameters

- `q` string
- `offset` integer

## Response `200`

OK

- GetPhoneBookResponse
  - `people` integer, required
  - `matches` integer, required
  - `sources` object[], required
    - `source` 'phone' | 'file', required
    - `device` string, nullable, required
    - `numbers` integer, required
    - `syncedAt` string, date-time, required
  - `items` object[], required
    - `name` string, required
    - `phones` E164[], required
    - `contactId` string, required
    - `urgent` boolean, required
    - `warning` boolean
  - `next` integer, nullable, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `500`: Unexpected server error (reported to Sentry).

---

[API](https://skmtc.dev/vicem/apis/vicem-api.md) · [All operations](https://skmtc.dev/vicem/apis/vicem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vicem/apis/vicem-api/revisions/9efcec07e5f4?raw)