Proteside Docs
Endpoint referenceStores

List stores

GET
/stores

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
status?string
Value in"active""suspended""deleted"
limit?integer
Range1 <= value <= 100
Default50
cursor?string

Opaque cursor from next_cursor

Response Body

Stores with their SDK config

application/json
  1. response
data?array<>
next_cursor?string|null
curl -X GET "https://example.com/stores"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",      "name": "string",      "domain": "string",      "country": "string",      "timezone": "string",      "status": "active",      "sdk_key": "string",      "safe_slug": "string",      "emergency_contact": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "sdk_config": {        "mode": "monitor",        "calibration_seconds": 0,        "overlay_check_interval_ms": 0,        "installation_order_policy": "warn",        "payment_methods": [          "pix"        ],        "sensitive_fields": [          "string"        ],        "expected_iframe_origins": [          "string"        ],        "allowed_service_workers": [          "string"        ],        "gtm_containers": [          "string"        ],        "developer_mode": true,        "release_channel": "stable",        "updated_at": "2019-08-24T14:15:22Z"      },      "recipients": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "method": "pix",          "key_masked": "string",          "key_hash": "string",          "label": "string",          "active": true,          "created_at": "2019-08-24T14:15:22Z"        }      ]    }  ],  "next_cursor": "string"}