Skip to main content

List number reservations

GET 
/number_reservations

Gets a paginated list of phone number reservations.

Request ​

Query Parameters

    page object

    Consolidated page parameter (deepObject style). Originally: page[size], page[number]

    filter object

    Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.phone_number], filter[customer_reference]

Responses ​

200: Successful response with a list of number reservations.

Schema

    data

    object[]

  • Array [

    • id uuid
    record_type string

    phone_numbers

    object[]

  • Array [

    • id uuid
    record_type string
    phone_number string
    status string

    Possible values: [pending, success, failure]

    The status of the phone number's reservation.

    created_at date-time

    An ISO 8901 datetime string denoting when the individual number reservation was created.

    updated_at date-time

    An ISO 8901 datetime string for when the the individual number reservation was updated.

    expired_at date-time

    An ISO 8901 datetime string for when the individual number reservation is going to expire

  • ]

    • status string

    Possible values: [pending, success, failure]

    The status of the entire reservation.

    customer_reference string

    A customer reference string for customer look ups.

    created_at date-time

    An ISO 8901 datetime string denoting when the numbers reservation was created.

    updated_at date-time

    An ISO 8901 datetime string for when the number reservation was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    object[]

  • Array [

    • code stringrequired
    title stringrequired
    detail string

    source

    object

    pointer string

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/number_reservations' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "record_type": "number_reservation",
      "phone_numbers": [
        {
          "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
          "record_type": "reserved_phone_number",
          "phone_number": "+19705555098",
          "status": "pending",
          "created_at": "2018-01-01T00:00:00.000000Z",
          "updated_at": "2018-01-01T00:00:00.000000Z",
          "expired_at": "2018-01-01T00:00:00.000000Z",
          "errors": ""
        }
      ],
      "status": "pending",
      "customer_reference": "MY REF 001",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}