Contacts

List contacts

get/contacts

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/contacts
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Query parameters

searchstring
type'customer' | 'supplier' | 'both'

customer and supplier (vendor) also return contacts of type both

pageinteger
limitinteger
includeInactiveboolean

Set to true to also return contacts marked inactive (isActive=false), which are hidden by default.

includeBalancesboolean

Set to true to add a balance object per contact: open, overdue, openCount, overdueCount, lastActivity, lifetimeBilled. Amounts are integer cents; overdue is derived from due dates, not the stored status.

balance'open' | 'overdue'

open keeps contacts with a positive unpaid balance on open (non-draft, non-void, unpaid) invoices; overdue counts only invoices past their due date. Results are ordered by the sort column, then id.

Response

Paginated contacts

Changes

No recorded changes to this operation across all 5 revisions of this API.