v52

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

Phone Number Orders

List sub number orders

Get a paginated list of sub number orders.

get/sub_number_orders

Query parameters

country_codestring

ISO alpha-2 country code.

order_request_idstring uuid

ID of the number order the sub number order belongs to

phone_number_typestring

Phone Number Type

phone_numbers_countinteger

Amount of numbers in the sub number order

statusstring

Filter sub number orders by status.

Consolidated filter parameter (deepObject style). Originally: filter[status], filter[order_request_id], filter[country_code], filter[phone_number_type], filter[phone_numbers_count]

{
  "country_code": "US",
  "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
  "phone_number_type": "local",
  "phone_numbers_count": 1
}

Response

Successful response with a list of sub number orders.

Example response

{
  "data": [
    {
      "country_code": "US",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "customer_reference": "MY REF 001",
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
      "phone_number_type": "local",
      "phone_numbers_count": 1,
      "record_type": "sub_number_order",
      "regulatory_requirements": [
        {
          "field_type": "address",
          "record_type": "phone_number_regulatory_requirement",
          "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
        }
      ],
      "requirements_met": true,
      "updated_at": "2018-01-01T00:00:00.000000Z",
      "user_id": "d70873cd-7c98-401a-81b6-b1ae08246995"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}