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

# List sub number orders

`GET /sub_number_orders`

Get a paginated list of sub number orders.

## Query parameters

- `filter` object
  - `status` string — Filter sub number orders by status.
  - `order_request_id` string, uuid — ID of the number order the sub number order belongs to
  - `country_code` string — ISO alpha-2 country code.
  - `phone_number_type` string — Phone Number Type
  - `phone_numbers_count` integer — Amount of numbers in the sub number order

## Response `200`

Successful response with a list of sub number orders.

- object
  - `data` SubNumberOrder[]
    - `id` string, uuid
    - `order_request_id` string, uuid
    - `country_code` string
    - `phone_number_type` 'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' | 'landline'
    - `user_id` string, uuid
    - `regulatory_requirements` SubNumberOrderRegulatoryRequirement[]
      - `record_type` string
      - `requirement_id` string, uuid — Unique id for a requirement.
      - `field_type` 'textual' | 'datetime' | 'address' | 'document'
    - `record_type` string
    - `phone_numbers_count` integer — The count of phone numbers in the number order.
    - `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.
    - `status` 'pending' | 'success' | 'failure' — The status of the order.
    - `customer_reference` string — A customer reference string for customer look ups.
    - `is_block_sub_number_order` boolean — True if the sub number order is a block sub number order
  - `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)