Customer
Retrieves a list of customers.
get/admin/customers.json
Query parameters
idsstring
Restrict results to customers specified by a comma-separated list of IDs.
since_idinteger
Restrict results to those after the specified ID.
created_at_minstring date-time
Show customers created after a specified date. format: 2014-04-25T16:15:47-04:00)
created_at_maxstring date-time
Show customers created before a specified date. format: 2014-04-25T16:15:47-04:00)
updated_at_minstring date-time
Show customers last updated after a specified date. format: 2014-04-25T16:15:47-04:00)
updated_at_maxstring date-time
Show customers last updated before a specified date. format: 2014-04-25T16:15:47-04:00)
limitinteger
The maximum number of results to show.
fieldsstring
Show only certain fields, specified by a comma-separated list of field names.
Response
OK
Example response
{
"customers": [
{
"accepts_marketing": true,
"addresses": [
{
"address1": "123 Fake Street",
"city": "Fakecity",
"country": "Vietnam",
"country_code": "VN",
"country_name": "Viet nam",
"cpf_or_cnpj_number": "CPF: 231.234.234-23, CNPJ: 23.123.423/4234-24",
"first_name": "John",
"last_name": "Smith",
"name": "example name",
"province": "Ontario",
"zip": "K2P 1L4"
}
],
"average_spent": 37.96,
"created_at": "2012-08-24T14:01:46-04:00",
"currency": "USD",
"default_address": {
"address1": "123 Fake Street",
"city": "Fakecity",
"country": "Vietnam",
"country_code": "VN",
"country_name": "Viet nam",
"cpf_or_cnpj_number": "CPF: 231.234.234-23, CNPJ: 23.123.423/4234-24",
"first_name": "John",
"last_name": "Smith",
"name": "example name",
"province": "Ontario",
"zip": "K2P 1L4"
},
"email": "test@shopbase.com",
"first_name": "John",
"id": 107333978,
"last_name": "English",
"last_order_at": "2012-08-24T14:01:46-04:00",
"last_order_id": 234132602919,
"last_order_name": "#1169",
"last_sent_abandoned_email_at": "2012-08-24T14:01:46-04:00",
"note": "Placed an order that had a fraud warning",
"orders_count": 6,
"phone": "+16135551111",
"state": "disabled",
"tags": "loyal",
"tax_exempt": true,
"total_spent": 37.96,
"updated_at": "2012-08-24T14:01:46-04:00",
"verified_email": true
}
]
}