Studios

List studios

GET
/api/v1/studios

The studios the organization owns (not handed over yet) or has access to (handed over), oldest first. Each carries the state of the hand-over. Org-level: send no Shyni-Business header. Requires the businesses:read scope.

Authorization

ApiKeyAuth businesses:read
headerAuthorizationBearer <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: businesses:read

Query Parameters

page?integer
Range1 <= value
Default1
perPage?integer
Range1 <= value <= 100
Default20

Response Body

One page of studios.

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://api.shyni.io/api/v1/studios' \  -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'

Response 200

One page of studios.

{  "data": [    {      "id": "string",      "name": "string",      "slug": "string",      "createdAt": "2019-08-24T14:15:22Z",      "handedOver": true,      "ownerInvite": {        "email": "string",        "sentAt": "2019-08-24T14:15:22Z"      }    }  ],  "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."}