GET
https://www.app.ocoya.com/api/_public/v1/studio-templates
List Studio templates
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/studio-templates \
  --header 'X-API-Key: <api-key>'
{
  "total": 1,
  "totalFiltered": 1,
  "totalAll": 24,
  "data": [
    {
      "id": "design_123",
      "name": "Product launch",
      "image": "https://cdn.ocoya.com/prod/template/preview.png",
      "thumbnail": "https://cdn.ocoya.com/prod/template/preview.png",
      "pageThumbnails": [
        "https://cdn.ocoya.com/prod/template/preview.png"
      ],
      "pagesCount": 1,
      "width": 1080,
      "height": 1080
    }
  ]
}

Authorizations

X-API-Keystringheaderrequired

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

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"
querystring

Search query used to filter results by name or matching text.

Example:"Launch"
pageinteger

Zero-based page number for paginated results.

Example:0
perPageinteger

Maximum number of items to return per page.

Example:20

Response

application/json

Success

totalinteger

Templates matching the query.

Example:1
totalFilteredinteger

Templates matching the query and filters.

Example:1
totalAllinteger

All templates available to the brand.

Example:24
dataobject[]

This page of templates.

Show child attributesHide child attributes
data.idstring

Studio design ID. Pass it in referenceDesignIds.

Example:"design_123"
data.namestring

Template name. Untitled template when it has none.

Example:"Product launch"
data.imagestring

Preview image URL.

Example:"https://cdn.ocoya.com/prod/template/preview.png"
data.thumbnailstring

Thumbnail image URL.

Example:"https://cdn.ocoya.com/prod/template/preview.png"
data.pageThumbnailsstring[]

Thumbnail of each page, for multi-page designs.

Example:
[
  "https://cdn.ocoya.com/prod/template/preview.png"
]
data.pagesCountinteger

Number of pages in the design.

Example:1
data.widthnumber | null

Design width in pixels.

Example:1080
data.heightnumber | null

Design height in pixels.

Example:1080