get

/customers

Returns a list of all Customers. Default sorting is by customer id, from lowest to highest. Optional parameters can be passed in.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

14 Query Parameters
2 Headers

Responses

2 Examples
Schema
array[object]
id
integer

Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

1 validation
_authentication
object

Not returned in any responses, but accepts up to two fields allowing you to set the customer’s password. If a password is not supplied, it is generated automatically. For further information about using this object, please see the Customers resource documentation.

company
string

The name of the company for which the customer works.

1 validation
first_name
string

First name of the customer.

1 validation + required
last_name
string

Last name of the customer.

1 validation + required
email
string

Email address of the customer.

1 validation + required
phone
string

Phone number of the customer.

1 validation
date_created
string

Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

2 validations
date_modified
string

Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

2 validations
store_credit
string

The amount of credit the customer has. (Float, Float as String, Integer)

1 validation
registration_ip_address
string

The customer’s IP address when they signed up.

1 validation
customer_group_id
integer

The group to which the customer belongs.

1 validation
notes
string

Store-owner notes on the customer.

tax_exempt_category
string

Used to identify customers who fall into special sales-tax categories – in particular, those who are fully or partially exempt from paying sales tax. Can be blank, or can contain a single AvaTax code. (The codes are case-sensitive.) Stores that subscribe to BigCommerce’s Avalara Premium integration will use this code to determine how/whether to apply sales tax. Does not affect sales-tax calculations for stores that do not subscribe to Avalara Premium.

accepts_marketing
boolean

If the customer accepts product review emails or abandon cart emails. Read-Only.

2 validations
addresses
object
form_fields
array[object]

Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.

reset_pass_on_login
boolean

Force a password change on next login.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
store_hash
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client