List number orders

gethttps://api.telnyx.com/v2/number_orders

Get a paginated list of number orders.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/number_orders?filter[phone_numbers.phone_number][]=%2B18665552368"

Parameters

In Query
filter[status]
string
optional
Filter number orders by status.
filter[created_at][gt]
string
optional
Filter number orders later than this value.
filter[created_at][lt]
string
optional
Filter number orders earlier than this value.
filter[phone_numbers_count]
string
optional
Filter number order with this amount of numbers
filter[customer_reference]
string
optional
Filter number orders via the customer reference set.
filter[requirements_met]
boolean
optional
Filter number orders by requirements met.
page[number]
integer
(1)
optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)
optional
The size of the page
Default:
20

Responses

200
Successful response with a list of number orders.
default
Unexpected error

Success Response

{
  "data": [
    {
      "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
      "connection_id": "346789098765567",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "customer_reference": "MY REF 001",
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
      "phone_numbers_count": 1,
      "record_type": "number_order",
      "requirements_met": true,
      "status": "pending",
      "sub_number_order_ids": [
        "string"
      ],
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/number_orders

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/number_orders/{number_order_id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/number_orders/{number_order_id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/sub_number_orders

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/sub_number_orders/{sub_number_order_id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/number_order_phone_numbers

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/number_order_phone_numbers/{number_order_phone_number_id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/number_order_phone_numbers/{number_order_phone_number_id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/comments

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/comments

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/phone_numbers_regulatory_requirements

...

...

Parameters

Responses

Success Response

Was this page helpful?