Skip to main content

List Invoices

Retrieve a paginated list of invoices.

Endpoint​

GET /invoices

Authentication​

X-API-Key (passed in the Authorization header)

Request Parameters​

Query Parameters​

ParameterTypeRequiredDefaultDescription
sizeintegerNo20The number of invoices to return per page.
pageintegerNo0The page number to retrieve (zero-indexed).
sortstringNo—The field to sort by. Prefix with - for descending order.
statusstringNo—Filter by invoice status.
customerIdstringNo—Filter by customer unique identifier.
companyIdstringNo—Filter by company unique identifier.
fromDatestring (date)No—Filter invoices created on or after this date (ISO 8601 format).
toDatestring (date)No—Filter invoices created on or before this date (ISO 8601 format).

Request Headers​

HeaderValueRequiredDescription
AuthorizationX-API-Key: {{apiKey}}YesX-API-Key for authentication.

Example Request​

curl -X GET "https://api.example.com/invoices?size=20&page=0" \
-H "X-API-Key: {{apiKey}}"

Request Schema​

No request body is required for this endpoint.