GET
/
orders
/
List all orders
curl --request GET \
  --url http:localhost:3000/v2/orders/ \
  --header 'x-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "chatId": "<string>",
    "items": [
      {}
    ],
    "customOrder": true,
    "comment": "<string>",
    "userId": "<string>",
    "objectId": "<string>",
    "completed": true,
    "approvedBy": "<string>",
    "objectManagerId": "<string>",
    "invoiceId": "<string>"
  }
]

Authorizations

​
x-API-Key
string
header
required

Query Parameters

​
limit
integer
default:100
Required range: 1 <= x <= 1000
​
offset
integer
default:0
Required range: x >= 0
​
sort
string

Response

200
application/json

List of orders

The response is of type Material Order · object[].