Proteside Docs
Endpoint referenceRules

List rules

GET
/rules

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Query Parameters

org_id?string

Partners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.

Formatuuid
store_id?string

Filter by store

Formatuuid
type?string
Value in"block""allow"
active?boolean
limit?integer
Range1 <= value <= 100
Default50
cursor?string

Opaque cursor from next_cursor

Response Body

Rules

application/json
  1. response
data?array<>
next_cursor?string|null
curl -X GET "https://example.com/rules"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",      "type": "block",      "target": "domain",      "value": "string",      "label": "string",      "active": true,      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}