Customers

List all customers

get/accounting/customers

Request

  • Base URL: https://api.clearbooks.co.uk/v1
  • URL: https://api.clearbooks.co.uk/v1/accounting/customers
  • Auth: OAuth 2 (authorization code, authorization URL https://secure.clearbooks.co.uk/account/action/oauth/, token URL https://api.clearbooks.co.uk/oauth/token, scopes: accounting.customers:read)

Query parameters

sortBystring

The field to sort results by

sortDirection'ascending' | 'descending'

The direction to sort the results

limitinteger

The number of results to return

pageinteger

The page of results to return

Headers

X-Business-IDinteger

ID of the business to use (required for multi-business authorisations only)

Response

An array of customers

idinteger
namestring required
emailstring
phonestring
vatNumberstring
companyNumberstring
externalIdstring

Identifier for this contact in an external system. Clear Books does not make use of this value beyond storing it for integrated applications.

archivedboolean

Changes

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