API Reference

List invoices

get
https://api-sandbox.cargoboard.com/v1/invoices

Returns your invoices as a paginated list. Supports paging, sorting and filtering.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
0 to 50

Number of results per page (max. 50). Required.

number

Cursor for the next page — take the value from the previous response.

orderBy
array of strings
Defaults to sequence

Sort order: sequence (ascending, default) or -sequence (descending).

orderBy
filter
array of strings

Filter expression <field><operator><value>, e.g. isPaid=false or dueDate<2026-12-01. Several filters are combined with AND. Filterable fields: id, documentNumber, documentId, documentAmount, isDocumentCompleted, documentCompletedAt, isDocumentCancelled, documentCancelledAt, isDocumentSent, documentSentAt, isDone, dueDate, dueInDays, isPaid, paidAt, paymentAmount, paymentCurrency, createdAt, updatedAt. Text values that look like numbers must be quoted, e.g. documentNumber="2026000001". ~ (contains) only works on id and documentNumber. See Filtering and Searching.

filter
boolean
Defaults to false

Set to true to include the total number of results.

Responses

403

Missing or invalid X-API-KEY, or no access to this resource.

409

The API key is not linked to a customer account.

422

Validation failed — the message array lists the missing or invalid fields.

Updated 3 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago