Skip to main content
GET
Retrieve a customer
Requires the customers:read scope. See Authentication.

Authorizations

Authorization
string
header
required

An API key. Its scopes decide what it may call: customers:read (List and look up customers.) customers:write (Create customers, and Xero contacts where the organisation allows it.) catalogue:read (List plans and charges.) subscriptions:read (List and look up subscriptions.) subscriptions:write (Create subscriptions, change units, end and restore them.) invoices:read (List and look up invoices.)

Path Parameters

id
string
required

The Saasybill id of the customer.

Example:

"3b9f1c1e-6a52-4c0e-9d7e-1f6f2f0b7a11"

Response

Success.

id
string
required
object
string
required
Allowed value: "customer"
code
string | null
required
name
string
required
company_name
string | null
required
first_name
string | null
required
last_name
string | null
required
email
string | null
required
status
enum<string>
required
Available options:
active,
inactive
xero_contact_id
string | null
required
created
string<date-time>
required

ISO 8601, UTC.