Skip to main content
GET
/
invoices
List invoices
curl --request GET \
  --url https://apiv2.example.com/invoices \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "invoiceId": "094f10ca-616e-441c-b264-9a2305d6692d",
      "customerId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "invoiceNumber": "INV-2024-001",
      "status": "SENT",
      "dueDate": "2024-02-15",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z",
      "subtotalAmount": 29.99,
      "totalAmount": 29.89,
      "currency": "USD",
      "sentAt": "2024-01-15T10:00:00Z",
      "paidAt": "2024-02-10T14:30:00Z",
      "voidedAt": "2024-02-05T09:00:00Z",
      "invoiceUrl": "https://invoices.yourapp.com/094f10ca-616e-441c-b264-9a2305d6692d",
      "metadata": {}
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

​
customerId
string[]

Filter invoices by customer IDs

​
status
enum<string>[]

Filter invoices by status

Current status of the invoice lifecycle.

Available options:
DRAFT,
SENT,
PAID,
VOID,
OVERDUE
​
fromDate
string<date>

Filter invoices created from this date

​
toDate
string<date>

Filter invoices created up to this date

​
dueDateFrom
string<date>

Filter invoices with due date from this date

​
dueDateTo
string<date>

Filter invoices with due date up to this date

Response

Invoices retrieved successfully

​
items
object[]
required
​
pagination
object
required