v52

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

Phone Number Block Orders

List number block orders

Get a paginated list of number block orders.

get/number_block_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]

phone_numbers.starting_numberstring

Filter number block orders having these phone numbers.

statusstring

Filter number block orders by status.

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

{
  "created_at": {
    "gt": "2018-01-01T00:00:00.000000Z",
    "lt": "2018-01-01T00:00:00.000000Z"
  },
  "phone_numbers.starting_number": "+19705555000",
  "status": "pending"
}

Response

Successful response with a list of number block orders.

Example response

{
  "data": [
    {
      "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": 10,
      "range": 10,
      "record_type": "number_block_order",
      "requirements_met": true,
      "starting_number": "+19705555000",
      "status": "pending",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}