Skip to main content
List customers

Authorizations

X-API-Key
string
header
required

Query Parameters

bigcommerce_id
number
custom_fields
string
email
string
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

Response

200 - application/json
id
string<uuid>
required
read-only
bigcommerce_id
integer
required
read-only
created_at
string<date-time>
required
read-only
first_name
string
required
Required string length: 1 - 100
last_name
string
required
Required string length: 1 - 100
email
string<email>
required
Required string length: 1 - 254
organization
object
required
is_approved
boolean
required
read-only
approved_at
string<date-time> | null
required
read-only
approval_expiration
string<date> | null
required
read-only
approved_by
object
required
created_by
object
required
custom_fields
object[]
required
labels
object[]
required
read-only
billing_email

An optional email address to CC on invoices and receipts.

phone
string
default:""
Maximum string length: 50
company_name
string
default:""
Maximum string length: 255
bigcommerce_customer_group_id
integer
bigcommerce_tax_exempt_category
string
default:""
Maximum string length: 255