IQ Books — Contacts

List customers

Paginated list of customers. Supports ?search, ?include_archived=true, and ?limit/?offset. Requires scope iqbooks:read.

get/api/v1/iqbooks/organisations/{organisationId}/customers

Request

  • Base URL: https://api.reconcileiq.com
  • URL: https://api.reconcileiq.com/api/v1/iqbooks/organisations/{organisationId}/customers
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

organisationIdinteger required

IQ Books organisation id. The caller must be an accepted member; otherwise 404 (no existence leak).

Query parameters

limitinteger

Page size, integer 1..200 (default 50). Out-of-range values return 422 invalid_request_format.

offsetinteger

Zero-based row offset (default 0).

searchstring
include_archived'true' | 'false'

Response

Paginated contacts.

Changes

No recorded changes to this operation across all 1 revision of this API.