Sign in

v1

latestOpenAPI 3.1.02026-07-261450274.9 KB

Get Orders

Retrieve a list of orders.

get/orders

Query parameters

pagenumber

Page number

typesnumber[]

List of Order Type IDs (same as order types)

branch_idsnumber[]

List of Location IDs

idsnumber[]

List of Order IDs

numbersstring[]

List of Order document numbers

statusesnumber[]

List of Order Status IDs

managersnumber[]

List of Employee IDs

client_idsnumber[]

List of Client (Person / Organization) IDs

client_namesstring[]

List of Client (Person / Organization) names

client_phonesstring[]

List of phone numbers

asset_uidstring[]

List of asset serial numbers (vin, imei)

created_atstring[]

Filter by creation date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

modified_atstring[]

Filter by modification date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

closed_atstring[]

Filter by close date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

scheduled_forstring[]

Filter by "Scheduled from" date and time. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

due_datestring[]

Filter by due date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

sort'id' | '-id' | 'modified_at' | '-modified_at' | 'scheduled_for' | '-scheduled_for' | 'due_date' | '-due_date' | 'closed_at' | '-closed_at'

Defines the sorting order of returned results. Use a field name to sort ascending or prefix it with a minus sign (-) to sort descending.

Response

200

object required