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

# List orders

`GET /api/v1/orders`

Returns a paginated list. Supports `?page`, `?limit`, `?sort`, `?order`, and any field as a filter (e.g. `?status=pending`). Also supports `?delay`, `?error`, `?random_fail` for simulation. Need richer filters (ranges, contains, in-lists)? Send the same request as **QUERY /api/v1/orders** with a JSON body instead — see the API description above.

## Query parameters

- `page` integer
- `limit` integer
- `sort` string
- `order` 'asc' | 'desc' | 'ASC' | 'DESC'
- `delay` integer
- `error` integer
- `random_fail` 'true' | 'false'

## Response `200`

Default Response

- object
  - `success` boolean
  - `data` object[]
    - `id` string, uuid
    - `user_id` string, uuid, nullable
    - `product_id` string, uuid, nullable
    - `quantity` integer
    - `status` 'pending' | 'processing' | 'completed' | 'cancelled'
    - `notes` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `user` object, nullable — Populated when ?expand=user
      - `id` string, uuid
      - `name` string
      - `email` string, email
      - `role` 'user' | 'admin' | 'moderator'
      - `age` integer, nullable
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `product` object, nullable — Populated when ?expand=product
      - `id` string, uuid
      - `name` string
      - `price` number
      - `description` string
      - `stock` integer
      - `category` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
  - `pagination` object
    - `total` integer — Total matching records
    - `page` integer
    - `limit` integer
    - `pages` integer — Total page count
    - `hasNext` boolean
    - `hasPrev` boolean

---

[API](https://skmtc.net/totalshiftleft/apis/api-learning-sandbox.md) · [All operations](https://skmtc.net/totalshiftleft/apis/api-learning-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/totalshiftleft/api-learning-sandbox/revisions/3b3179c504b0/schema)