---
title: "Get a Studio design"
method: GET
path: "/studio-designs/{designId}"
tags: ["Studio designs"]
---

# Get a Studio design

`GET /studio-designs/{designId}`

## Request

- Base URL: `https://www.app.ocoya.com/api/_public/v1`
- URL: `https://www.app.ocoya.com/api/_public/v1/studio-designs/{designId}`
- Auth: API key in header `X-API-Key`

Returns one Studio design with the fields it accepts when rendered.

## Path parameters

- `designId` string, required

## Query parameters

- `brandId` string, required

## Response `200`

Success

- object
  - `id` string, required: Studio design ID.
  - `name` string, required: Design name.
  - `thumbnail` string, nullable, required: Preview image URL.
  - `fields` object[], required: The text, image and colour layers that can be filled in.
    - `id` string, required: Field ID. Use it as the key in `fields` when rendering.
    - `label` string, required: The layer's name in Studio, or what it currently says.
    - `type` 'text' | 'image' | 'color', required: What the field takes: text, an image URL, or a CSS colour.
    - `value` string, nullable, required: What the field holds in the saved design.

## Other responses

- `401`: Missing or invalid API key.
- `403`: Invalid brand id, or the API key's user does not own this brand.
- `404`: Studio design not found.
- `429`: Rate limit exceeded: 60 requests per minute per API key.
- `500`: Unknown error

## Changes

- **2026-11-04** `ef9bd3530850`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ocoya/apis/ocoya-api/changes/studio-designs/:designId/get.md)

---

[API](https://skmtc.dev/ocoya/apis/ocoya-api.md) - [All operations](https://skmtc.dev/ocoya/apis/ocoya-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ocoya/apis/ocoya-api/revisions/ef9bd3530850?raw)