GET
https://www.app.ocoya.com/api/_public/v1/studio-designs/{designId}
Get a Studio design
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/studio-designs/{designId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "design_123",
  "name": "Weekly offer",
  "thumbnail": "https://perma.pixy.art/preview.png",
  "fields": [
    {
      "id": "pixy-cmte4jx8o00ml3570hpuny2ze",
      "label": "WARMTH IN EVERY SIP.",
      "type": "text",
      "value": "WARMTH IN EVERY SIP."
    }
  ]
}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Path Parameters

designIdstringrequired

Studio design ID, from GET /studio-designs.

Example:"design_123"

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Response

application/json

Success

idstring

Studio design ID.

Example:"design_123"
namestring

Design name.

Example:"Weekly offer"
thumbnailstring | null

Preview image URL.

Example:"https://perma.pixy.art/preview.png"
fieldsobject[]

The text, image and colour layers that can be filled in.

Show child attributesHide child attributes
fields.idstring

Field ID. Use it as the key in fields when rendering.

Example:"pixy-cmte4jx8o00ml3570hpuny2ze"
fields.labelstring

The layer's name in Studio, or what it currently says.

Example:"WARMTH IN EVERY SIP."
fields.typeenum<string>

What the field takes: text, an image URL, or a CSS colour.

Available options: text, image, color
Example:"text"
fields.valuestring | null

What the field holds in the saved design.

Example:"WARMTH IN EVERY SIP."