---
title: "List number orders"
method: GET
path: "/number_orders"
tags: ["Phone Number Orders"]
---

# List number orders

`GET /number_orders`

Get a paginated list of number orders.

## Query parameters

- `page` object
  - `size` integer — The size of the page
  - `number` integer — The page number to load
- `filter` object
  - `status` string — Filter number orders by status.
  - `created_at` object — Filter number orders by date range.
    - `gt` string — Filter number orders later than this value.
    - `lt` string — Filter number orders earlier than this value.
  - `phone_numbers_count` string — Filter number order with this amount of numbers
  - `customer_reference` string — Filter number orders via the customer reference set.
  - `requirements_met` boolean — Filter number orders by requirements met.

## Response `200`

Successful response with a list of number orders.

- object
  - `data` NumberOrder[]
    - `id` string, uuid
    - `record_type` string
    - `phone_numbers_count` integer — The count of phone numbers in the number order.
    - `connection_id` string — Identifies the connection associated with this phone number.
    - `messaging_profile_id` string — Identifies the messaging profile associated with the phone number.
    - `billing_group_id` string — Identifies the messaging profile associated with the phone number.
    - `phone_numbers` PhoneNumbersJobPhoneNumber[]
      - `phone_number` string — The phone number in e164 format.
      - `id` string — The phone number's ID
    - `sub_number_orders_ids` string[]
    - `status` 'pending' | 'success' | 'failure' — The status of the order.
    - `customer_reference` string — A customer reference string for customer look ups.
    - `created_at` string, date-time — An ISO 8901 datetime string denoting when the number order was created.
    - `updated_at` string, date-time — An ISO 8901 datetime string for when the number order was updated.
    - `requirements_met` boolean — True if all requirements are met for every phone number, false otherwise.
  - `meta` PaginationMeta
    - `total_pages` integer
    - `total_results` integer
    - `page_number` integer
    - `page_size` integer

## Other responses

- `400` — Bad request, the request was unacceptable, often due to missing a required parameter.
- `401` — Unauthorized
- `404` — The requested resource doesn't exist.
- `422` — Unprocessable entity. Check the 'detail' field in response for details.
- `500` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)