Skip to main content

List number orders


Get a paginated list of number orders.


Query Parameters

    filter[status] string

    Filter number orders by status.

    filter[created_at][gt] string

    Filter number orders later than this value.

    filter[created_at][lt] string

    Filter number orders earlier than this value.

    filter[phone_numbers_count] string

    Filter number order with this amount of numbers

    filter[customer_reference] string

    Filter number orders via the customer reference set.

    filter[requirements_met] boolean

    Filter number orders by requirements met.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page


200: Successful response with a list of number orders.

default: Unexpected error

Request samples

curl -L '' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

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