Sign in
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
  }
}

Changes

Changed in 2 of the 61 revisions of this API.20515

  • 1571b0380bd7155See the full diff
    • ▲

      the response property errors/items/code became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 500

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 500

      response-property-became-optional

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 500 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379945510See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 500 status

      response-optional-property-removed

    • ○

      the response property errors/items/code became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 500

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 500

      response-property-became-required

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog