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>
default:this_month

The period.

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

The first day of a period of your own, as YYYY-MM-DD. With to, in place of range.

to
string

Its last day, as YYYY-MM-DD.

tz
string

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

Example:

"Europe/Berlin"

Part of a payee, a note or a reference.

category
string

Only expenses in this expense category, by its ID.

method
enum<string>

Only expenses paid this way.

Available options:
card,
bank,
crypto,
paypal,
cash,
other

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
meta
object