Get store configuration

Returns the store configuration for the API-key's community, including display settings, currency configuration, and optional widget data.

Use this when a partner integration needs to render the community storefront shell, currency labels, store copy, or widget configuration before listing categories and products.

Authentication:

Bearer API key in Authorization header

API key must have the store permission

Community is resolved from the API key token — do not pass communityID

Returns 401 if the key is missing, invalid, or expired

Returns 403 if the key does not include the store permission

Rate limits:

Standard API rate limits apply

Constraints:

fields is a comma-separated projection and must use selectable store configuration fields

lang selects translated content when the store has localized fields

Invalid fields values return 400

Upstream store-service failures return 502

Example — read:

{ "query": "?fields=title,widget&lang=en" }

Related endpoints:

GET /categories — list store categories

GET /categories/{categoryID} — read a single store category

GET /products — list active store products

GET /products/{productID} — read a single store product

{ "meta": { "status": "success", "statusCode": 200 }, "message": "Read store config success.", "data": { "_id": "507f1f77bcf86cd799439011", "communityID": "6502c9e514a3e564c5c09c0a", "isEnabled": true, "title": "Rewards Store", "description": "<p>Redeem community rewards.</p>", "cover": { "type": "image", "value": "https://example.com/cover.png" }, "currency": { "name": "Coins", "symbol": "coin" }, "widgetID": "650906d314a3e564c56f3450", "widget": { "isEnabled": true }, "createdAt": "2026-04-28T00:00:00.000Z", "updatedAt": "2026-04-28T00:00:00.000Z" } }

Request

Responses