v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

List

This request will return an array of all customers.

get/customers/

Query parameters

livestring

Account status: active = 'True'

emailstring

Customer's email address

updatedstring date

Objects whose updated date matches exactly (yyyy-mm-dd). On customer creation it is populated with same value as created field.

updated_startstring date

Objects whose updated datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

updated_endstring date

Objects whose updated datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

createdstring date

Objects whose created date matches exactly (yyyy-mm-dd)

created_startstring date

Objects whose created datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

created_endstring date

Objects whose created datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

Response

200

merchantstring

merchant_user_idstring

session_idstring

user_token_idstring

first_namestring

last_namestring

emailstring

phone_numberstring

phone_typeinteger

liveboolean

createdstring

last_updatedstring

{"stackTrail":"paths:/customers/:get:responses:200:content:application/json:schema:properties:last_login","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/customers/:get:responses:200:content:application/json:schema:properties:extra_data","oasType":"schema","type":"unknown"}

localeinteger

Example response

{
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "merchant_user_id": "00040003",
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.66746.1539289512",
  "first_name": "APPLE",
  "last_name": "CIDER",
  "email": "acider@test.com",
  "phone_number": "+15165551212",
  "live": true,
  "created": "2018-11-12 15:45:39",
  "last_updated": "2018-11-15 21:49:10",
  "locale": 1
}