---
title: "List your orders, newest first"
method: GET
path: "/api/agent/v1/orders"
---

# List your orders, newest first

`GET /api/agent/v1/orders`

## Request

- Base URL: `https://essentras.com`
- URL: `https://essentras.com/api/agent/v1/orders`
- Auth: HTTP bearer

Requires orders:read.

## Query parameters

- `limit` integer
- `offset` integer
- `channel` 'all' | 'api'

## Response `200`

A page of orders

- object
  - `object` 'list'
  - `total` integer
  - `limit` integer
  - `offset` integer
  - `has_more` boolean
  - `results` Order[]
    - `object` 'order'
    - `id` string: Order id for the API (the public id).
    - `number` integer, nullable
    - `status` string
    - `payment_status` string
    - `fulfillment` 'awaiting_payment' | 'awaiting_brief' | 'in_progress' | 'partially_published' | 'published' | 'cancelled' | 'refunded'
    - `channel` 'api' | 'reseller_portal' | 'website'
    - `created_at` string, date-time
    - `paid_at` string, date-time, nullable
    - `currency` 'USD'
    - `pricing_basis` 'list' | 'reseller'
    - `subtotal` number
    - `discount` number
    - `discount_reason` string, nullable
    - `total` number
    - `paid_from_wallet` number
    - `client_reference` string, nullable
    - `line_items` object[]
      - `id` string: Outlet id.
      - `name` string
      - `type` string
      - `quantity` integer
      - `unit_price` number
      - `list_price` number
      - `amount` number
      - `placement_note` string, nullable
      - `status` 'in_progress' | 'published'
      - `live_url` string, uri, nullable
      - `published_at` string, date-time, nullable
    - `brief` object, nullable
      - `status` string
      - `submitted_at` string, date-time, nullable
      - `article_status` string
    - `dashboard_url` string, uri

## Other responses

- `401`: authentication_required, invalid_api_key, api_key_revoked or api_key_expired
- `403`: insufficient_scope (with required_scope) or ip_not_allowed
- `429`: rate_limited

---

[API](https://skmtc.dev/essentras/apis/essentras-agent-api.md) · [All operations](https://skmtc.dev/essentras/apis/essentras-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/essentras/apis/essentras-agent-api/revisions/17a4d739e1b1?raw)