Sign in
Customers

List customers

Retrieve existing customers.

get/v2/customers

Query parameters

limitnumber

Maximum number of items to return (1-100).

Example:50

Maximum number of items to return (1-100).

cursorstring

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

boolean
OR
'true' | 'false'

Set to true to include total in the response.

order'asc' | 'desc'

Sort direction.

Example:desc

Sort direction.

sort'created_at' | 'updated_at'

Field used to sort the results.

Field used to sort the results.

namestring
name__notstring
name__isNullstring
name__isNotNullstring
name__equalsstring
name__containsstring
name__startsWithstring
name__endWithstring
'corporate' | 'person'
OR
string

corporate,person

'corporate' | 'person'
OR
string

corporate,person

'all' | 'active' | 'inactive' | 'imported' | 'archived'
OR
string

all,active

'all' | 'active' | 'inactive' | 'imported' | 'archived'
OR
string

all,active

currencystring
currency__notstring
currency__isNullstring
currency__isNotNullstring
currency__equalsstring
currency__containsstring
currency__startsWithstring
currency__endWithstring
countrystring
country__notstring
country__isNullstring
country__isNotNullstring
country__equalsstring
country__containsstring
country__startsWithstring
country__endWithstring
external_idstring
external_id__notstring
external_id__isNullstring
external_id__isNotNullstring
external_id__equalsstring
external_id__containsstring
external_id__startsWithstring
external_id__endWithstring
billing_emailstring
billing_email__notstring
billing_email__isNullstring
billing_email__isNotNullstring
billing_email__equalsstring
billing_email__containsstring
billing_email__startsWithstring
billing_email__endWithstring
searchstring
tax_idstring
tax_id__notstring
tax_id__isNullstring
tax_id__isNotNullstring
tax_id__equalsstring
tax_id__containsstring
tax_id__startsWithstring
tax_id__endWithstring
'active' | 'pending' | 'cancelled' | 'paused' | 'trialing' | 'errored' | 'draft' | 'none'
OR
string

active,pending

'active' | 'pending' | 'cancelled' | 'paused' | 'trialing' | 'errored' | 'draft' | 'none'
OR
string

active,pending

invoicing_entity_idstring
invoicing_entity_id__notstring
invoicing_entity_id__isNullstring
invoicing_entity_id__isNotNullstring
invoicing_entity_id__equalsstring
invoicing_entity_id__containsstring
invoicing_entity_id__startsWithstring
invoicing_entity_id__endWithstring
segment_idstring
custom_propertiesstring
'card' | 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs' | 'transfer' | 'external' | 'missing' | 'errored'
OR
string

card,direct_debit

'card' | 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs' | 'transfer' | 'external' | 'missing' | 'errored'
OR
string

card,direct_debit

integration_entity_idstring
created_atstring date-time
created_at__notstring date-time
created_at__isNullstring date-time
created_at__isNotNullstring date-time
created_at__equalsstring date-time
created_at__ltstring date-time
created_at__ltestring date-time
created_at__gtstring date-time
created_at__gtestring date-time
updated_atstring date-time
updated_at__notstring date-time
updated_at__isNullstring date-time
updated_at__isNotNullstring date-time
updated_at__equalsstring date-time
updated_at__ltstring date-time
updated_at__ltestring date-time
updated_at__gtstring date-time
updated_at__gtestring date-time

Response

CursorPaginatedCustomer required— unresolved $ref

Changes