List Customers

Deprecated

GET

https://api.bigcommerce.com/stores/:store_hash/v2/customers

GET

/stores/:store_hash/v2/customers

curl https://api.bigcommerce.com/stores/store_hash/v2/customers \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

[
  {
    "email": "janedoe@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "_authentication": {
      "force_reset": true,
      "password": "string",
      "password_confirmation": "string"
    },
    "accepts_marketing": true,
    "addresses": {
      "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/customers/5/addresses",
      "resource": "/customers/5/addresses"
    },
    "company": "BigCommerce",
    "customer_group_id": 2,
    "date_created": "string",
    "date_modified": "string",
    "form_fields": [
      {
        "name": "License ID",
        "value": "string"
      }
    ],
    "id": 1,
    "notes": "string",
    "phone": "1234567890",
    "registration_ip_address": "12.345.678.910",
    "reset_pass_on_login": false,
    "store_credit": "0",
    "tax_exempt_category": "string"
  }
]

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

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

first_namestringOptional

Filter customers by first name.

last_namestringOptional

Filter customers by last name.

companystringOptional

Filter customers by company name.

emailstringOptional

Filter customers by email address.

phonestringOptional

Filter customers by phone number.

store_creditstringOptional

Filter customers by store credit amount.

customer_group_idintegerOptional

Filter customers by customer group ID.

min_idintegerOptional

Filter results to those with an ID greater than or equal to this value.

max_idintegerOptional

Filter results to those with an ID less than or equal to this value.

min_date_createdstringOptional

Filter results to those created on or after this date.

max_date_createdstringOptional

Filter results to those created on or before this date.

min_date_modifiedstringOptional

Filter results to those modified on or after this date.

max_date_modifiedstringOptional

Filter results to those modified on or before this date.

tax_exempt_categorystringOptional

Filter customers by tax exempt category code.

Response

emailstring

Email address of the customer.

first_namestring

First name of the customer.

last_namestring

Last name of the customer.

_authenticationobjectOptional

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.

accepts_marketingbooleanOptionalRead-only

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

addressesobjectOptional

companystringOptional

The name of the company for which the customer works.

customer_group_idintegerOptional

The group to which the customer belongs.

date_createdstringOptionalRead-only

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.

date_modifiedstringOptionalRead-only

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.

form_fieldslist of objects or nullOptionalRead-only

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

idintegerOptionalRead-only

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.

notesstringOptional

Store-owner notes on the customer.

phonestringOptional

Phone number of the customer.

registration_ip_addressstringOptional

The customer’s IP address when they signed up.

reset_pass_on_loginbooleanOptional

Force a password change on next login.

store_creditstringOptional

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