Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

range
enum<string>

Only customers first seen in this period.

Available options:
today,
yesterday,
7d,
30d,
this_week,
last_week,
this_month,
last_month,
this_year
from
string

Only customers first seen on or after this day, as YYYY-MM-DD. With to, in place of range.

to
string

Only customers first seen on or before this day, as YYYY-MM-DD.

tz
string

The time zone those days are in, as an IANA name. Left out, UTC.

Example:

"Europe/Berlin"

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object