Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Query Parameters

schema
enum<string>
required

GOBL document type to search. See the field reference in this endpoint's description for the fields available on each type.

Available options:
bill/delivery,
bill/invoice,
bill/order,
bill/payment,
bill/status,
note/message,
org/item,
org/party
filter
string

Filter expression. Combine terms with AND; use OR only between values of a single field. See this endpoint's field reference for the fields available and the operators each accepts.

Example:

"state = \"sent\" AND issue_date > \"2026-01-01\""

order_by
string

Sort order, as a field name optionally followed by asc or desc. Defaults to the schema's own order.

Example:

"issue_date desc"

limit
integer

Maximum number of entries in a page of results, up to 100.

Example:

20

cursor
string

Position marker from a previous result's next_cursor. Only valid for the same schema, filter and order_by.

fields
string

Comma-separated list of fields to populate on each entry. Fewer fields means less work for the database, not merely a smaller response. Defaults to the standard set.

Example:

"id,code,state,issue_date"

count
boolean

When true, the response includes the number of matching entries. This costs an additional query, so it is off by default.

Response

200 - application/json

OK

count
integer

Number of matching entries, when count was requested.

Example:

42

count_capped
boolean

When true, counting stopped at an internal limit and the real total is at least count.

count_unavailable
boolean

When true, the count could not be produced in time. The entries in this page are still valid.

cursor
string

Cursor that produced this page, when one was given.

filter
string

Filter expression that was applied.

limit
integer

Maximum number of entries in this page of results.

Example:

20

list
List · object[] | null

Array of matching entries.

next_cursor
string

Cursor for the next page. Absent on the last page.

notes
string[]

Non-fatal advisories about the query, such as a filter that no index covers.

order_by
string

Sort order that was applied.

schema
string

Document type that was searched.

Example:

"bill/invoice"

watermark
string

Timestamp of the most recent change known to be reflected in these results. Results are eventually consistent, so a recently created entry may not appear until the watermark passes its creation time.

Example:

"2026-01-01T00:00:00.000Z"