Read the publish state
Whether the studio is published, and which parts and sections have unpublished changes. Parts are CATALOG
(sections kapacita, pravidla, hodiny, sluzby, balicky) and STOREFRONT (galerie, kontakt,
moje-stranka); changes counts the differing items of a section. Neither the preview token nor the calendar
feed token of the admin is part of it. 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 publish state.
application/json- response
visibility*string"NEVER_PUBLISHED""PUBLISHED""HIDDEN"publishedAt*|date-timehasUnpublishedChanges*booleanparts*array<>curl -X GET 'https://api.shyni.io/api/v1/publish-state' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
The publish state.
{ "visibility": "NEVER_PUBLISHED", "publishedAt": "2019-08-24T14:15:22Z", "hasUnpublishedChanges": true, "parts": [ { "part": "CATALOG", "hasUnpublishedChanges": true, "sections": [ { "key": "kapacita", "changes": 0 } ] } ]}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."}