List the draft services
The services as the studio is editing them - the DRAFT the admin shows, archived services included
(active: false) - so an integrator can learn the id to PATCH and see what it wrote before publishing.
GET /services stays the published catalog that customers and publishable keys see. A service created or
changed through the API appears here at once and in GET /services only after POST /catalog/publish.
categoryId narrows the list to one category; ordered by sortOrder, then id. 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
page?integer1 <= value1perPage?integer1 <= value <= 10020categoryId?stringOne page of draft services.
application/json- response
data*array<>meta*curl -X GET 'https://api.shyni.io/api/v1/catalog/draft/services' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
One page of draft services.
{ "data": [ { "id": "string", "slug": "string", "name": "string", "description": { "plain": "string", "html": "string", "json": { "v": 0, "doc": {} } }, "scope": "PRIMARY", "basePrice": 0, "currency": "string", "durationMinutes": 0, "employeesRequired": 0, "postWorkStrategy": "NONE", "postWorkMinutes": 0, "variants": [ { "code": "string", "priceMultiplier": 0, "extraMinutes": 0 } ], "discountPercent": 0, "pricingMode": "EXACT", "minAdvanceDays": 0, "renewalIntervalMonths": 0, "multiDay": true, "storefrontVisible": true, "sortOrder": 0, "categoryId": "string", "highlight": "NONE", "active": true, "imageId": "string", "includes": [ "string" ], "forWhom": "string", "recommendedAddonIds": [ "string" ], "orderAudience": "ALL", "soldOnlyWithServiceIds": [ "string" ] } ], "meta": { "page": 0, "perPage": 0, "total": 0 }}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}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."}