---
title: "List number reservations"
method: GET
path: "/number_reservations"
tags: ["Phone Number Reservations"]
---

# List number reservations

`GET /number_reservations`

Gets a paginated list of phone number reservations.

## Query parameters

- `page` object
  - `size` integer — The size of the page
  - `number` integer — The page number to load
- `filter` object
  - `status` string — Filter number reservations by status.
  - `created_at` object — Filter number reservations by date range.
    - `gt` string — Filter number reservations later than this value.
    - `lt` string — Filter number reservations earlier than this value.
  - `phone_numbers.phone_number` string — Filter number reservations having these phone numbers.
  - `customer_reference` string — Filter number reservations via the customer reference set.

## Response `200`

Successful response with a list of number reservations.

- object
  - `data` NumberReservation[]
    - `id` string, uuid
    - `record_type` string
    - `phone_numbers` ReservedPhoneNumber[]
      - `id` string, uuid
      - `errors` string — Errors the reservation could happen upon
      - `record_type` string
      - `phone_number` string
      - `status` 'pending' | 'success' | 'failure' — The status of the phone number's reservation.
      - `created_at` string, date-time — An ISO 8901 datetime string denoting when the individual number reservation was created.
      - `updated_at` string, date-time — An ISO 8901 datetime string for when the the individual number reservation was updated.
      - `expired_at` string, date-time — An ISO 8901 datetime string for when the individual number reservation is going to expire
    - `status` 'pending' | 'success' | 'failure' — The status of the entire reservation.
    - `customer_reference` string — A customer reference string for customer look ups.
    - `created_at` string, date-time — An ISO 8901 datetime string denoting when the numbers reservation was created.
    - `errors` string — Errors the reservation could happen upon
    - `updated_at` string, date-time — An ISO 8901 datetime string for when the number reservation was updated.
  - `meta` PaginationMeta
    - `total_pages` integer
    - `total_results` integer
    - `page_number` integer
    - `page_size` integer

## Other responses

- `400` — Bad request, the request was unacceptable, often due to missing a required parameter.
- `401` — Unauthorized
- `404` — The requested resource doesn't exist.
- `422` — Unprocessable entity. Check the 'detail' field in response for details.
- `500` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/8f5f4e537994/schema)