Catalog

Read the subject types of the studio

GET
/api/v1/subject-types

What an order's subject is checked against. A detailing (AUTO) studio has one built-in type, CAR, with the attributes plate, make, model: identity is the plate, else make and model (identityFallbackKeys), and the summary reads make model · plate. A GENERIC studio has the types it defined with PUT /subject-types (empty until then). Requires the catalog:read scope; a publishable key cannot call it.

Authorization

ApiKeyAuth catalog: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: catalog:read

Response Body

The subject types in display order.

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

Response 200

The subject types in display order.

{  "types": [    {      "code": "string",      "label": "string",      "attributes": [        {          "key": "string",          "label": "string",          "type": "text",          "options": [            "string"          ],          "required": true        }      ],      "identityKeys": [        "string"      ],      "identityFallbackKeys": [        "string"      ],      "summaryKeys": [        "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."}