---
title: "List all orders"
method: GET
path: "/v0/orders"
tags: ["Order"]
---

# List all orders

`GET /v0/orders`

List of all orders in the workspace.

## Query parameters

- `user_id` string
- `limit` integer
- `offset` integer

## Response `200`

OK

- ClerkListOrdersResponse
  - `orders` ClerkOrder[]
    - `created_at` string
    - `created_by` string — uuid of the user who created the order
    - `id` string
    - `order_items` ClerkOrderItem[]
      - `area` integer — UTM based area of the current order in sq. km.
      - `bandset` ClerkOrderItemBandset
        - `bands` ClerkBand[] — list of bands in the bandset
          - `name` string — name of the band
          - `wavelength` number — wavelength of the band in nm
        - `bandset_id` string — id of the bandset
        - `custom` array[]
          - integer[]
      - `base_amount` number — base amount of the order item without any uplifts or discounts
      - `cloud_cover` integer — maximum cloud cover percentage for the tasking order
      - `cloud_delivery` ClerkCloudDelivery
        - `config` string, required — id of the store
        - `path` string — prefix path to which resource should be transferred to
      - `created_at` string — timestamp of the creation of the order item
      - `created_by` string — uuid of the user who created the order item
      - `delivery_speed` 'STANDARD' | 'NOT_APPLICABLE'
      - `end_date` string — end date of your tasking order, the utc date will be considered as the end date.
      - `feasibility_status` 'NOT_APPLICABLE' | 'FAILED' | 'WEAK_SUCCESS' | 'SUCCESS' | 'UNSPECIFIED'
      - `final_amount` number — final amount of the order item after applying uplifts and discounts
      - `id` string — unique identifier of the order item
      - `image_type` 'VNIR' | 'SWIR' | 'VSWIR'
      - `images` ClerkImage[] — list of images associated with the order item
        - `geometry` unknown
        - `item_id` string — STAC item id for the image
      - `last_feasibility_check` string — (only for tasking) timestamp of the feasibility status. Feasibility status can change wrt time for the same order.
      - `name` string — name of the order item
      - `no_of_occurrences` integer — number of occurrences of the recurring order.
      - `number_of_bands` integer — number of bands in the tasking order
      - `occurrences` ClerkInterval[] — list of intervals of recurring orders.
        - `end` string — end time of the interval
        - `start` string — start time of the interval
      - `off_nadir` integer — maximum off nadir angle for the tasking order
      - `order_id` string — UUID of the order
      - `org_id` string — UUID of the workspace
      - `payment_status` 'PAID' | 'PARTIAL-REFUND' | 'REFUND' | 'UNPAID' | 'PARTIAL-MONTHLY'
      - `project_id` string — UUID of the project
      - `recurrence` 'ONCE' | 'MONTHLY' | 'BIMONTHLY' | 'QUARTERLY' | 'NOT_APPLICABLE'
      - `start_date` string — start date of your tasking order, the utc date will be considered as the start date.
      - `status` 'DRAFT' | 'ACTIVE' | 'FULFILLED' | 'CANCELLED' | 'FAILED' | 'PARTIALLY_FULFILLED'
      - `tokens_used` integer — tokens used by the order item, populated only after payment
      - `transaction_id` string — transaction id assorciated with the order item
      - `type` 'TASKING' | 'ARCHIVE' | 'RECURRING'
      - `updated_at` string — timestamp of the last update of the order item
      - `updated_by` string — uuid of the user who last updated the order item
      - `uplifts` ClerkUplift[] — list of uplifts/discounts applied to the order
        - `amount` integer — delta amount due to the uplift
        - `item_id` string — (only for archive order) the item id to which the uplift applies
        - `percentage` integer — percentage of the uplift
        - `subtitle` string — description of the uplift
        - `title` string — type/cause of the uplift
      - `usecase` string — usecase for which this order was requested
      - `user_id` string — UUID of the user
    - `org_id` string
    - `paid_at` string
    - `status` 'PAID' | 'REFUND' | 'UNPAID' | 'PAYMENT_IN_PROGRESS'
    - `total_amount` number
    - `transaction_id` string
    - `updated_at` string
    - `updated_by` string — uuid of the user who last updated the order
    - `user_id` string
  - `pagination` CommonPagination
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/pixxel/apis/stargate.md) · [All operations](https://skmtc.net/pixxel/apis/stargate/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pixxel/stargate/revisions/b501e2ca5a9d/schema)