OCocoya
Studio designs

Get a Studio design

Changed on

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

get/studio-designs/{designId}

Request

  • Base URL
    https://www.app.ocoya.com/api/_public/v1
  • Auth
    API key in header X-API-Key

Path parameters

designIdstring required
Example:design_123

Studio design ID, from GET /studio-designs.

Query parameters

brandIdstring required
Example:cmayvq3hk00017apshay5qezu

Ocoya brand ID. Get one from GET /brands.

Response

Success

idstring required

Studio design ID.

namestring required

Design name.

thumbnailstring nullable required

Preview image URL.

Example response

{
  "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."
    }
  ]
}

Changes