---
title: "List Numbers"
method: GET
path: "/v1/numbers/list"
tags: ["numbers"]
---

# List Numbers

`GET /v1/numbers/list`

## Query parameters

- `page` integer
- `size` integer
- `sort_column` string, nullable
- `sort_desc` boolean, nullable

## Response `200`

Successful Response

- PhoneNumberPage
  - `items` NormalizedPhoneNumber[], required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `active` boolean
    - `label` string
    - `inbound_agent` string, uuid, nullable
    - `outbound_only` boolean
    - `example_context` object, nullable
    - `number` string, required
    - `telephony_provider` 'vonage' | 'twilio'
    - `telephony_account_connection` union
      - string, uuid
      - TwilioAccountConnection
        - `id` string, uuid, required
        - `user_id` string, uuid, required
        - `credentials` TwilioCredentials, required
          - `twilio_account_sid` string, required
          - `twilio_auth_token` string, required
        - `type` 'account_connection_twilio', required
        - `steering_pool` string[]
        - `account_supports_any_caller_id` boolean
  - `page` integer, required
  - `size` integer, required
  - `has_more` boolean, required
  - `total` integer, required
  - `total_is_estimated` boolean, required

## Other responses

- `422` — Validation Error

## Changes

- **2024-08-14** `63991d99e2e1` — 3 breaking, 6 info
  - the response property `items/items/inbound_agent` became optional for the status `200`
  - response property `items/items/example_context` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/inbound_agent` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - `query` request parameter `sort_column` list-of-types was widened by adding types `null`
  - …5 more
- **2024-04-19** `55ae0e0bb01f` — 2 info
  - added the required property `total` to the response with the `200` status
  - added the required property `total_is_estimated` to the response with the `200` status
- **2024-04-15** `47ab17602d64` — 2 info
  - added the optional property `items/items/telephony_account_connection/anyOf[subschema #2: TwilioAccountConnection]/account_supports_any_caller_id` to the response with the `200` status
  - added the optional property `items/items/telephony_account_connection/anyOf[subschema #2: TwilioAccountConnection]/steering_pool` to the response with the `200` status
- **2024-03-18** `8b2983fa7531` — 5 info
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `size`
  - added the new optional `query` request parameter `sort_column`
  - added the new optional `query` request parameter `sort_desc`
  - …1 more
- …earlier changes not shown

[Full history](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/changes/v1/numbers/list/get.md)

---

[API](https://skmtc.dev/vocodedev/apis/vocode-hosted-api.md) · [All operations](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vocodedev/vocode-hosted-api/revisions/ffca17c004e2/schema)