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

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.

check
enum<string>

1 for how many rows the file would have, as { rows }, in place of the file. Not counted against the store's exports, and refused with 429 where none are left.

Available options:
1

Response

The file itself, not a JSON envelope.

The response is of type file.