---
title: "List your number orders"
method: GET
path: "/v1/numbers/orders"
tags: ["numbers"]
---

# List your number orders

`GET /v1/numbers/orders`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/numbers/orders`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns your workspace's number orders, newest first. Filter by status to find in-progress or failed orders.

## Query parameters

- `status` string: Lifecycle state of a number purchase order: - `charging`: Securing funds. - `ordering`: Placing the order with the carrier. - `pending`: The carrier accepted the order and is provisioning the number. - `completed`: Your workspace owns the number. - `failed`: The purchase did not complete. A setup fee already charged is non-refundable. Contact support about a failed order.
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

List of the workspace's number orders.

- NumbersOrderList
  - `data` NumbersOrder[], required
    - `id` string, required
    - `number` string, required: The number being acquired, in E.164 format.
    - `country_code` string, required: ISO 3166-1 alpha-2 country code.
    - `number_type` string, required: Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
    - `status` string, required: Lifecycle state of a number purchase order: - `charging`: Securing funds. - `ordering`: Placing the order with the carrier. - `pending`: The carrier accepted the order and is provisioning the number. - `completed`: Your workspace owns the number. - `failed`: The purchase did not complete. A setup fee already charged is non-refundable. Contact support about a failed order.
    - `number_id` string
    - `failure_reason` string, nullable: Human-readable reason the purchase failed. `null` unless status is failed. An order can fail some time after it was created, so `updated_at` tells you when the failure was recorded rather than when the order was placed.
    - `completed_at` string, date-time, nullable: When the purchase completed and the number became owned (status completed). `null` for orders still in progress or failed.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6dfce1179799?raw)