---
title: "Retrieves the collection of Order resources."
method: GET
path: "/orders"
tags: ["Order"]
---

# Retrieves the collection of Order resources.

`GET /orders`

Retrieves the collection of Order resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Order collection

- Order[]
  - `id` string — Unique identifier for this order note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-726"
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcID` string — The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"
  - `name` string, nullable — Order name e.g. "New order"
  - `orderDate` string, date-time, nullable — Date and time the order is created e.g. "2019-08-25T02:17:40.080Z"
  - `orderStatus` string, nullable — Status of the order e.g. "activated"
  - `description` string, nullable — Additional details about the order e.g. "Monthly bundle"
  - `amount` string, nullable — Amount of the order e.g. "1200"
  - `quantity` integer, nullable — The number of items included in the order e.g. 5
  - `modified` string, date-time, nullable — When the order was last modified e.g. "2019-08-25T02:17:40.080Z"
  - `customerId` string, nullable — Id of the customer the order is by e.g. "C005"
  - `firstName` string, nullable — First name of the customer e.g. "Jane"
  - `lastName` string, nullable — Last name of the customer e.g. "Doe"
  - `currency` string, nullable — The currency the order was made in e.g. "USD"

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)