Get store configuration

Reads the current community store configuration aggregate for the API-key's community, including display settings, currency configuration, i18n settings, and populated widget data with defaults.

Use this before rendering a partner storefront shell. Omit fields to receive the complete public aggregate; pass fields only when you intentionally want a projected response.

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 an optional comma-separated projection and must use selectable store configuration fields

Omit fields for the full public aggregate and default values

lang selects translated content when the store has localized fields

Internal identifiers such as widgetID and widget._id are not exposed

Invalid fields values return 400

Upstream store-service failures return 502

Example — read full aggregate:

{ "query": "?lang=en" }

Related endpoints:

PUT /stores

{ "meta": { "status": "success", "statusCode": 200 }, "message": "Read store config success.", "data": { "_id": "650a619360e8475d8ce4b2d4", "communityID": "6502c9e514a3e564c5c09c0a", "isEnabled": true, "title": "The Concept Trading update", "description": "<p>Redeem community rewards.</p>", "cover": { "isEnabled": false, "light": "", "dark": "" }, "currency": { "isEnabled": false, "name": "Coins", "light": "", "dark": "" }, "i18n": { "isTranslationEnabled": false, "titleTranslations": [], "descriptionTranslations": [], "translationPrompt": "", "translationIgnoreList": [] }, "widget": { "isEnabled": true, "allowedDomains": [], "accessMode": "live", "testUsers": [], "testRoles": [], "size": { "mode": "dynamic", "width": 400, "height": 400 }, "appearance": { "light": { "name": "violet-dream", "palette": {} }, "dark": { "name": "black-beauty", "palette": { "accent": "rgb(3, 169, 244)", "text": "rgb(0, 150, 218)", "background": "rgb(3, 23, 38)", "divider": "rgb(19, 71, 95)", "shadow": "rgba(26, 38, 43, .5)" } }, "useCommunityTheme": false }, "callToAction": { "isEnabled": false, "text": "", "link": "" }, "userIdentifierFields": [], "apiKey": "9d644e64ce43b0cfd4b428b03fb0f962f0f093078b2b618fbf1aaf7d8b668b06", "createdAt": "2026-04-15T12:41:45.223Z", "updatedAt": "2026-04-15T12:42:22.024Z", "__v": 0 }, "createdAt": "2026-04-15T12:41:45.223Z", "updatedAt": "2026-04-15T12:42:22.024Z", "__v": 0 } }

Request

Responses