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

page
integer
default:1

Which page of the list. The first is 1.

perPage
integer
default:20

How many a page holds.

status
enum<string>

Only rules that are in force, or only ones switched off.

Available options:
enabled,
disabled
type
enum<string>

Only rules of this type.

Available options:
email,
domain,
ip,
cidr,
asn,
isp,
city

Part of a rule's value or note.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
pages
integer
total
integer
meta
object