Proteside Docs
Endpoint referenceStores

Get a store

GET
/stores/{id}

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.

Path Parameters

id*string
Formatuuid

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

Response Body

Store with SDK config and recipients

application/json
  1. response
id?string
Formatuuid
org_id?string
Formatuuid
name?string
domain?string
country?string
timezone?string
status?string
Value in"active""suspended""deleted"
sdk_key?string
safe_slug?string|null
emergency_contact?string|null
created_at?string
Formatdate-time
updated_at?string
Formatdate-time
sdk_config?|null
recipients?array<>
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"    }  ]}