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

# List Orders

`GET /orders/list`

## Request

- Base URL: `https://api.thanks.io/api/v2`
- URL: `https://api.thanks.io/api/v2/orders/list`
- Auth: HTTP bearer

Return list of recent orders.

## Query parameters

- `items_per_page` integer
- `sub_account_id` integer
- `type` 'postcard' | 'postcard6x9' | 'postcard6x11' | 'letter' | 'windowlessletter' | 'notecard' | 'giftcard' | 'magnacard' | '4x6-postcard' | '6x9-postcard'
- `creative_id` integer
- `campaign` integer

## Response `200`

OK

- object
  - `data` Order[]
    - `id` integer
    - `message` string
    - `size` string: Only valid for postcards
    - `sub_account_id` integer, nullable
    - `type` 'postcard' | 'postcard6x9' | 'postcard6x11' | 'letter' | 'notecard' | 'giftcard' | 'windowlessletter'
    - `display_type` string
    - `style` integer: Handwriting Style ID used for this order
    - `front_image` string
    - `high_quality_preview` string: PDF of the high quality preview of the order
    - `authorization_total` integer
    - `grand_total` integer
    - `order_total` integer
    - `total_estimated_recipients` integer
    - `total_recipients` integer
    - `recipient_count` integer
    - `status` string
    - `method` string
    - `cancellable` boolean
    - `total_scans` integer
    - `metadata` object, nullable: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `links` Links
    - `first` string, nullable: URL of the first page of results
    - `last` string, nullable: URL of the last page of results
    - `prev` string, nullable: URL of the previous page of results
    - `next` string, nullable: URL of the next page of results
  - `meta` Meta
    - `current_page` integer: Current page number
    - `from` integer, nullable: Index of the first item on the current page
    - `last_page` integer: Total number of pages
    - `path` string: Base URL for the resource
    - `per_page` integer: Number of items per page
    - `to` integer, nullable: Index of the last item on the current page
    - `total` integer: Total number of items

## Other responses

- `403`: Access token is missing or invalid

## Changes

- **2026-10-09** `9b6aa91faff7`: 2 info
  - added the new optional `query` request parameter `campaign`
  - added the new optional `query` request parameter `creative_id`
- **2026-10-09** `c76fc453c7ca`: 2 warning
  - deleted the `query` request parameter `campaign`
  - deleted the `query` request parameter `creative_id`
- **2026-10-09** `20cf809aaa0d`: 2 info
  - added the new optional `query` request parameter `campaign`
  - added the new optional `query` request parameter `creative_id`
- **2026-10-01** `5dbb26960beb`: 1 info
  - added the new optional `query` request parameter `type`
- **2026-10-01** `02de08ab2a47`: 1 warning
  - added the new `postcard6x9` enum value to the `data/items/type` response property for the response status `200`

[Operation history](https://skmtc.dev/thanks-io/apis/thanks-io-api/changes/orders/list/get.md)

---

[API](https://skmtc.dev/thanks-io/apis/thanks-io-api.md) · [All operations](https://skmtc.dev/thanks-io/apis/thanks-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thanks-io/apis/thanks-io-api/revisions/c403fbf3dc0f?raw)