---
title: "Queries orders with filtering and pagination."
method: GET
path: "/orders"
tags: ["Order"]
---

# Queries orders with filtering and pagination.

`GET /orders`

## Query parameters

- `page` integer
- `page_size` integer
- `sort` string[]
- `order_name` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `state` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `order_date` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `customer_mail` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `is_public` object
  - `eq` string
  - `neq` string
  - `gt` string
  - `gte` string
  - `lt` string
  - `lte` string
  - `contains` string
  - `starts_with` string
  - `ends_with` string
  - `in` string[]
  - `not_contains` string
- `logic` 'and' | 'or'

## Response `200`

OK

- QueryOrdersEndpointPagedResultOfOutput
  - `total` integer, required
  - `page` integer, required
  - `pageSize` integer, required
  - `items` QueryOrdersEndpointOutput[], required
    - `id` string, required — The unique identifier of the order.
    - `pipelineId` string, required — The ID of the pipeline associated with the order.
    - `orderDate` string, date-time, nullable, required — The date the order was placed.
    - `customerMail` string, required — The email of the customer who placed the order.
    - `state` 'Created' | 'Preview' | 'Submitted' | 'ManualReview' | 'Queued' | 'Processing' | 'Paused' | 'Completed' | 'Cancelled' | 'Failed' | 'StaleResults', required
    - `orderName` string, required — The name of the order.
    - `isPublic` boolean, required — Whether the order is publicly visible.
    - `failureMessage` string, nullable — The failure message if the order failed.
  - `totalPages` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `403` — Forbidden

---

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