List orders

get

https://orders.verbit.co/api/v2/orders

Retrieves a list of orders in the Verbit system, filtered by various criteria
You can filter my many different fields, including the order id, the recurrence id, free text and more!

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 300

Defaults to 50

The number of items to return.

offset

integer

≥ 0

Defaults to 0

The number of items to skip before returning the result set.

Search by Order Name or ID or Short ID or PO Number or Cost Center.

type

OrderType | null

Filter by the Order Type. Leave blank to exclude from filter. Press Ctrl and click to unselect an item.

status

array | null

Filter by Order Status. Leave blank to exclude from filter. Press Ctrl and click to unselect an item.

internal_status

array | null

Filter by Internal Status. Leave blank to exclude from filter.

product_type

ProductType | null

Filter by Product/Service. Leave blank to exclude from filter. Press Ctrl and click to unselect an item.

recurrence_id

Filter a recurring events by a unique Recurrence ID. Leave blank to exclude from filter.

recurrence

Filter for recurring events by selecting true. Selecting false will filter for non recurring events. Leave blank to exclude from filter.

group_id

Filter a grouped orders by a unique Group ID. Leave blank to exclude from filter.

collection_id

array | null

Filter by a unique Collection IDs. Leave blank to exclude from filter.

order_by

string

Defaults to [object Object]

Order by

modified_at

string

Defaults to [object Object]

Filter by the last modified date of an order. This can be an exact date or a date range. Leave blank to exclude from filter.

start_at

string

Defaults to [object Object]

Filter by the due date and time of an order. This can be an exact date or a date range. Leave blank to exclude from filter.

Responses

200Successful Response

400Bad Request

401Unauthorized

500Internal Server Error