v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Phone Number Orders

List number orders

Get a paginated list of number orders.

get/number_orders

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

customer_referencestring

Filter number orders via the customer reference set.

phone_numbers_countstring

Filter number order with this amount of numbers

requirements_metboolean

Filter number orders by requirements met.

statusstring

Filter number orders by status.

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

Response

Successful response with a list of number orders.

Example 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": [
        {
          "phone_number": "+19705555000"
        }
      ],
      "phone_numbers_count": 1,
      "record_type": "number_order",
      "requirements_met": true,
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}