---
title: "List phone books"
method: GET
path: "/phonebooks"
---

# List phone books

`GET /phonebooks`

List all phone books in your workspace.

## Headers

- `Authorization` string, required

## Response `200`

200

- ListPhoneBooksResponse200
  - `status` string — Whether the request was successful.
  - `response` PhonebooksGetResponsesContentApplicationJsonSchemaResponse
    - `total` number, double — Total number of phone books in your workspace.
    - `page_size` number, double — Number of entries per page.
    - `page_number` number, double — Page number.
    - `items` PhonebooksGetResponsesContentApplicationJsonSchemaResponseItemsItems[]
      - `phone_book_id` string — Phone book ID.
      - `workspace_id` string — Workspace ID.
      - `name` string — Phone book name.
      - `entry_count` number, double — Number of entries in this phone book.
      - `agents` unknown[] — List of agents this phone book is attached to.
        - unknown

---

[API](https://skmtc.dev/synthflow/apis/platform-api.md) · [All operations](https://skmtc.dev/synthflow/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/synthflow/platform-api/revisions/6976456ad422/schema)