List customers

get

https://api.smoothpos.net/customers.json

Returns your customers, 50 at a time by default, in ascending ID order. Narrow the list with the filters below and page through it with the X-Next-Page header.

Heads up: this is a `GET` request, but it changes data. Don't call it just to look something up, and keep it away from link prefetchers and caches.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Customers	List and view customers
Customers	Create, edit and delete customers (includes view)

Query Params

limit

integer

1 to 250

Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

cursor

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

since_id

integer

Only return customers with an ID greater than this one. Handy for picking up where you left off.

ids

string

Comma-separated list of customer IDs to fetch, e.g. 2099268,2099269.

string

Free-text search across customer details.

string

Only return customers with this email address.

first_name

string

Only return customers with this first name.

last_name

string

Only return customers with this last name.

tagged

string

Only records with any of these tags. Send one tag or a comma-separated list, up to 50.

sort_field

string

Older way to choose the sort field, used with sort=asc or sort=desc. Still supported. Keys: id, created, updated, lastname, firstname, fullname, email, loyaltypoints, loyaltytier, creditbalance, birthdate.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, created, updated, lastname, firstname, fullname, email, loyaltypoints, loyaltytier, creditbalance, birthdate. The older sort_field=key&sort=asc|desc style still works.

middle_name

string

Partial match on middle_name.

full_name

string

Partial match on full_name.

loyalty_optin

string

Exact match on loyalty_optin.

market_id

string

^\d+(,\d+)*$

Matches one market id or a comma-separated list (up to 200).

loyalty_tier

string

^\d+(,\d+)*$

Matches one loyalty tier or a comma-separated list (up to 200).

min_loyalty_tier

integer

Minimum loyalty tier, inclusive.

max_loyalty_tier

integer

Maximum loyalty tier, inclusive.

loyalty_points

string

^\d+(,\d+)*$

Matches one loyalty points or a comma-separated list (up to 200).

min_loyalty_points

integer

Minimum loyalty points, inclusive.

max_loyalty_points

integer

Maximum loyalty points, inclusive.

min_credit_balance

number

Minimum credit balance, inclusive.

max_credit_balance

number

Maximum credit balance, inclusive.

email_subscriber

boolean

Filter on email subscriber: true or false (1/0 and yes/no work too).

sms_subscriber

boolean

Filter on sms subscriber: true or false (1/0 and yes/no work too).

sex

string

Exact match on the free-text sex value. Send one value or a comma-separated list.

birthdate_from

string

From this birthdate. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

birthdate_to

string

Up to this birthdate. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

loyalty_optin_date_from

string

From this loyalty optin date. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

loyalty_optin_date_to

string

Up to this loyalty optin date. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

loyalty_tier_expiration_from

string

From this loyalty tier expiration. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

loyalty_tier_expiration_to

string

Up to this loyalty tier expiration. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_from

string

From this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_to

string

Up to this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_from

string

From this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_to

string

Up to this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: no customers found not authorised