Skip to main content
GET
List invoices for the workspace.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

status
string

Filter by invoice status: draft, sent, partial, paid, void or overdue.

contact
string

Filter to invoices for a single contact, by the contact's uuid.

from
string<date>

Only invoices with issue_date on or after this date (YYYY-MM-DD).

to
string<date>

Only invoices with issue_date on or before this date (YYYY-MM-DD).

per_page
integer

Items per page (alias: limit). Default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object