Customers

Retrieve a single customer

get/accounting/customers/{customerId}

Request

  • Base URL: https://api.clearbooks.co.uk/v1
  • URL: https://api.clearbooks.co.uk/v1/accounting/customers/{customerId}
  • 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)

Path parameters

customerIdinteger required

ID of customer

Headers

X-Business-IDinteger

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

Response

A customer object

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.