Skip to main content
GET
List customers
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.)

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
starting_after
string

The id of the last object on the previous page.

code
string

The customer's code.

email
string

Case-insensitive.

status
enum<string>

Only these.

Available options:
active,
inactive

Response

Success.

data
object[]
required
has_more
boolean
required