List

This request will return an array of all of a merchant’s customers if the user accessing this endpoint does so in API User Scope. Accessing this endpoint via Customer Scope will return only a single customer’s (i.e. the individual whose sig_field is in the header) information in the payload.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Body Definitions

NameTypeDescriptionExample
merchantstringMerchant ID"275dbe1d77f34aca968fb75a8dbb4c82"
merchant_user_idstringMerchant User ID"TEST"
session_idstringSession ID, obtained from og_session_id cookie"5bda04dc429d11e4bd78bc764e106cf4.463053.1418160308"
user_token_idstringUser Token ID"bda1c6b0084811e6965ebc764e106cf4"
first_namestringCustomer first name"John"
last_namestringCustomer last name"Doe"
emailstringCustomer email"[email protected]"
phone_numberstringCustomer phone number"+15551231234"
phone_typestringCustomer phone type.
Options: "invalid", "landline", "mobile", "voip"
"landline"
livebooleanAccount status: active = 'True'True
createdstringDate of customer account creation"2017-02-29 12:00:00"
last_updatedstringDate of most recent customer account update"2017-02-29 12:00:00"
last_loginstringDate of most recent customer login"2017-02-29 12:00:00"
extra_datastringRaw JSON string that should be JSON.parse() as key/value store for any extra information"{"some": "extra", "fields": "here"}"
localeintegerCustomer locale code42
Query Params
string

Account status: active = 'True'

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain