---
title: "List your orders"
method: GET
path: "/api/v1/orders"
tags: ["Orders"]
---

# List your orders

`GET /api/v1/orders`

## Request

- Base URL: `https://virtualsms.io`
- URL: `https://virtualsms.io/api/v1/orders`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

Newest first. Also served as `GET /api/v1/orders` only — there is no
singular list endpoint.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Orders returned

- object
  - `success` boolean
  - `orders` Order[]
    - `id` string, uuid
    - `phone_number` string
    - `service` string
    - `service_name` string: Display name. Returned by the list endpoint and by `GET /api/v1/orders/{id}`.
    - `country` string
    - `status` 'created' | 'waiting' | 'sms_received' | 'completed' | 'cancelled' | 'expired': `created` / `waiting` — live, no code yet. `sms_received` — a code arrived. `completed` — you called `/complete`. `cancelled` — you called `/cancel`. `expired` — the window elapsed; the auto-refund runs separately and is reported by `refunded_at`, the status stays `expired`.
    - `price` number, float
    - `sms_count` integer
    - `created_at` string
    - `expires_at` string
    - `selected_tier` string
    - `can_swap_number` boolean: Whether `POST /api/v1/orders/{id}/retry` will replace this order's number in place instead of resending to the same one.
    - `sms` string: Full SMS text. Present once a message has arrived.
    - `code` string: Verification code extracted from the SMS, when one was detected.
    - `sms_sender` string
    - `completed_at` string
    - `refunded_at` string: Set when the money actually went back, read from the balance ledger rather than inferred from `status`. List endpoint only.
  - `total` integer
  - `limit` integer
  - `offset` integer

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and.md) · [All operations](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/llms.txt) · [OpenAPI document](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/revisions/be89af981be1?raw)