Sign in

v1

latestSwagger 2.02026-07-17148179252.3 KB
Customers

Get All Customers

Returns a list of Customers. Optional filter parameters can be passed in. Notes Attribute names are not available on the customer object.

get/customers

Query parameters

pageinteger

Page number. page=1

limitnumber

Items count per page. limit=50

id:ininteger[]

Filter items by id. id:in=4,5,6

company:instring[]

Filter items by company. company:in=bigcommerce,commongood

customer_group_id:instring[]

Filter items by customer_group_id. customer_group_id:in=5,6

date_createdstring date-time

Filter items by date_created. date_created=2018-09-05T13:43:54

date_created:maxstring

Filter items by maximum date_created. date_created:max=2018-09-10

date_created:minstring date-time

Filter items by date_created. date_created:min=2018-09-05

date_modifiedstring date-time

Filter items by date_modified. date_modified=2018-09-05T13:45:03

date_modified:minstring

Filter items by mininum date_modified. date_modified:min=2019-09-04T:00:00:00 or date_modified:min=2019-09-04

date_modified:maxstring date-time

Filter items by maximum date_modified date_modified:max=2018-09-05T13:45:03 or date_modified:max=2019-09-04

email:instring

Filter items by email. email:in=janedoe@email.com

name:instring[]

Filter items by first_name and last_name. name=james moriarty

name:likestring[]

Filter items by substring in first_name and last_name. name:like=moriarty, sherlock Concatenates the first_name and last_name fields.

registration_ip_address:ininteger[]

Filter items by registration_ip_address. If the customer was created using the API, then registration address is blank. registration_ip_address:in=12.345.6.789

include'addresses' | 'storecredit' | 'attributes' | 'formfields'

Indicates whether to include customer sub-resources:

  • addresses - customer addresses
  • storecredit - store credit
  • attributes - customer attributes and address attributes
  • formfields - customer and address form fields include=addresses,storecredit,attributes,formfields
sort'date_created:asc' | 'date_created:desc' | 'last_name:asc' | 'last_name:desc'

Sort items by date_created or last_name:

  • date_created:asc - date created, ascending
  • date_created:desc - date created, descending
  • last_name:asc - last name, ascending
  • last_name:desc - last name, descending Example: sort=last_name:asc

Response

OK

Example response

{
  "data": [
    {
      "authentication": {
        "force_password_reset": true
      },
      "addresses": [
        {
          "address_type": "residential"
        }
      ],
      "store_credit_amounts": [
        {
          "amount": 43.18
        }
      ]
    }
  ]
}