List

get

https://restapi.ordergroove.com/customers/

This request will return an array of all customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🔐
Authentication
✔️ Application API Scope
✔️ Storefront API Scope
Note: Application API Scope with Bulk Operations permission is required to list more than one customer.

Response Body Definitions

Name	Type	Description	Example
merchant	string	Merchant ID	"275dbe1d77f34aca968fb75a8dbb4c82"
merchant_user_id	string	Merchant User ID	"TEST"
session_id	string	Session ID, obtained from og_session_id cookie	"5bda04dc429d11e4bd78bc764e106cf4.463053.1418160308"
user_token_id	string	User Token ID	"bda1c6b0084811e6965ebc764e106cf4"
first_name	string	Customer first name	"John"
last_name	string	Customer last name	"Doe"
email	string	Customer email	"[email protected]"
phone_number	string	Customer phone number	"+15551231234"
phone_type	int	Customer phone type. Options: 0, 1, 2, 30 = "Invalid" 1 = "Landline" 2 = "Mobile" 3 = "VoIP"	1
live	boolean	Account status: active = 'True'	True
created	string	Date of customer account creation	"2017-02-29 12:00:00"
last_updated	string	Date of most recent customer account update	"2017-02-29 12:00:00"
last_login	string	Date of most recent customer login	"2017-02-29 12:00:00"
extra_data	string	Raw JSON string that should be JSON.parse() as key/value store for any extra information	"{"some": "extra", "fields": "here"}"
locale	integer	Customer locale code	42
price_code	string	Customer price code	"prom_customer"

Query Params

live

string

Account status: active = 'True'

string

Customer's email address

updated

date

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

updated_start

date

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

updated_end

date

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

created

date

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

created_start

date

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

created_end

date

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Authentication

Response Body Definitions

200200

403403

404404