Filtering and Searching ๐Ÿ”Ž

Paginate, sort and filter the results of list endpoints.

The list endpoints โ€” List quotations, List orders and List invoices โ€” support pagination, sorting and filtering via query parameters.

Pagination

ParameterDescription
takeNumber of results per page, max. 50. Required for orders and invoices โ€” always set it.
cursorsequence of the item to continue after. You normally don't build it yourself โ€” see below.
totalSet to true to include the total number of results (total) in the response

The response contains a links array. If there are more results, it includes an entry with rel: "next" (and, when you paged forward, rel: "previous"). Call its href to get the next page โ€” it already contains take, cursor, orderBy and your filters. An empty links array means there are no further results.

GET /v1/orders?take=50&cursor=150
GET /v1/orders?take=50&total=true

Sorting

orderBy sorts by sequence (creation order). Use sequence for ascending (default) or -sequence for descending order.

GET /v1/orders?take=50&orderBy=sequence
GET /v1/orders?take=50&orderBy=-sequence

Filtering

filter takes an expression in the form <field><operator><value>:

OperatorMeaning
=Equals
!=Not equals
<Less than
<=Less than or equals
>Greater than
>=Greater than or equals
~Contains

Which operators are available depends on the type of the field: ~ only works on text fields, booleans only support = and !=.

  • To apply several filters, repeat the filter parameter. filterOperator=AND (default) or filterOperator=OR controls how they are combined.
  • To match several values of the same field, separate them with |.
  • Put text values that look like numbers, dates or booleans in double quotes, e.g. documentNumber="2026000001".
  • List invoices always combines filters with AND โ€” filterOperator isn't available there.
GET /v1/orders?take=50&filter=product=STANDARD
GET /v1/orders?take=50&filter=product=STANDARD&filter=createdAt>=2026-01-01
GET /v1/orders?take=50&filter=status=INITIALIZED|CREATED
๐Ÿ’ก

URL encoding

In real requests, URL-encode the filter value โ€” for example, >= becomes %3E%3D and | becomes %7C. Most HTTP clients do this for you.