ClientSphereDocs
API reference/Invoices

List invoices

Returns a paginated list of invoices. Read-only: invoices are raised in the app, not through the public API. Money fields are decimal strings, not numbers.

GET
/invoices

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1
limitinteger

Items per page (max 100)

Default: 20Maximum: 100
searchstring

Search term

statusstring

Exact status match, e.g. draft, sent, paid.

curl -X GET "https://clientsphere.io/api/v1/invoices?page=1&limit=20&search=%3Cstring%3E&status=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of invoices

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "invoiceNumber": "INV-2026-0043",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
      "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
      "recurringBillingId": "d4e3e1a2-3a0b-421e-899a-d0466402f1e1",
      "status": "sent",
      "currency": "USD",
      "exchangeRate": "string",
      "subtotal": "1200.00",
      "taxAmount": "240.00",
      "taxRate": "0.2000",
      "discountAmount": "0.00",
      "discountType": "string",
      "totalAmount": "1440.00",
      "issueDate": "2019-08-24T14:15:22Z",
      "dueDate": "2019-08-24T14:15:22Z",
      "paidDate": "2019-08-24T14:15:22Z",
      "paymentTerms": "Net 30",
      "description": "string",
      "notes": "string",
      "internalNotes": "string",
      "paymentInstructions": "string",
      "termsAndConditions": "string",
      "createdBy": 0,
      "sentBy": 0,
      "paidBy": 0,
      "sentAt": "2019-08-24T14:15:22Z",
      "remindersSent": 0,
      "lastReminderAt": "2019-08-24T14:15:22Z",
      "shareToken": "4f8ceca8-194c-4771-b5c7-8d8d71c92316",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

Previous

List activities GET

Next

Get invoice GET