Read the studio page draft
The content of the studio page ("my page") as the draft holds it, i.e. what the /storefront write endpoints change and the
admin shows: description, FAQ, why us, brands, custom sections (with their ids), the section layout, the theme and the
ids of the photos (hero, "about", logo, gallery, before/after). It is not what visitors see until
POST /storefront/publish. Requires the catalog:read scope; a publishable key cannot call it.
ApiKeyAuth catalog:readAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: catalog:read
The page draft.
application/json- response
The content of the studio page as the draft holds it - what the /storefront write endpoints change. It is live
only after POST /storefront/publish (GET /publish-state says whether something is waiting). The photo ids are
read-only here.
description*|nullfaq*array<>whyUs*array<>brands*array<>customSections*array<>layout*array<>theme*heroImageId*string|nullaboutImageId*string|nulllogoImageId*string|nullgalleryImageIds*array<string>beforeAfter*array<>curl -X GET 'https://api.shyni.io/api/v1/storefront' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
The page draft.
{ "description": { "plain": "string", "html": "string", "json": { "v": 0, "doc": {} } }, "faq": [ { "question": "string", "answer": { "plain": "string", "html": "string", "json": { "v": 0, "doc": {} } } } ], "whyUs": [ { "icon": "string", "title": "string", "body": "string" } ], "brands": [ { "imageId": "string", "name": "string" } ], "customSections": [ { "id": "string", "heading": "string", "body": { "plain": "string", "html": "string", "json": { "v": 0, "doc": {} } }, "imageId": "string" } ], "layout": [ { "id": "string", "type": "string", "enabled": true } ], "theme": { "accentMode": "string", "accentSwatch": "string", "accentHue": 0, "accentLightness": 0, "accentChroma": 0, "radius": "string", "neutral": "string", "font": "string", "hidePoweredBy": true }, "heroImageId": "string", "aboutImageId": "string", "logoImageId": "string", "galleryImageIds": [ "string" ], "beforeAfter": [ { "beforeImageId": "string", "afterImageId": "string", "label": "string", "serviceId": "string" } ]}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}