Skip to main content
GET
/
order_status
/
list
List all orders
curl --request GET \
  --url https://start.aiotic.ai/order_status/list \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": "2023-11-07T05:31:56Z",
      "attachments": {},
      "metadata": {},
      "result": {},
      "state": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Required on all endpoints except /healthcheck. Customer and product endpoints also accept a customer-specific API key.

Query Parameters

​
page
integer
default:1

Page number (starts at 1)

Required range: x >= 1
​
size
integer
default:100

Items per page

Required range: 1 <= x <= 1000

Response

Paginated list of orders

​
items
object[]
required

List of order status objects

​
total
integer
required

Total number of orders in the system

​
limit
integer
required

Maximum number of orders returned in this response

​
offset
integer
required

Number of orders skipped (for pagination)