Orders

List workers

GET
/api/v1/workers

The studio's active team members an order can be assigned to - use it to read assignedWorkerId of an order or of the order.worker_assigned webhook. Only id and display name are returned (no contact details). Not paged: a team is small. Needs the orders:read scope (there is no scope of its own) and a secret key; a publishable key is refused with 403 INSUFFICIENT_SCOPE.

Authorization

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

Response Body

The active team members, in the studio's roster order, wrapped in the list envelope with the array under data.

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

Response 200

The active team members, in the studio's roster order, wrapped in the list envelope with the array under data.

{  "data": [    {      "id": "string",      "name": "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."}