Orshot Logo
OrshotDocs

GET: List Studio Templates

Retrieve studio templates from your workspace with pagination

List all studio templates in your workspace with pagination support.

Endpoint

GET /templates/all

Returns templates with pagination support.

https://api.orshot.com/v1/studio/templates/all?page=1&limit=10

Query Parameters

ParameterTypeRequiredDefaultDescription
pageIntegerNo1Page number (must be > 0)
limitIntegerNo10Templates per page (max: 20, must be > 0)

Request Example

await fetch("https://api.orshot.com/v1/studio/templates/all?page=1&limit=10", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

Response Example

{
  "data": [
    {
      "id": 123,
      "created_at": "2025-09-10T15:30:45.123Z",
      "workspace_id": "workspace-uuid-456",
      "user_id": "user-uuid-789",
      "canvas_width": 1200,
      "canvas_height": 630,
      "updated_at": "2025-10-15T10:20:30.456Z",
      "name": "Social Media Post",
      "description": "Template for social media posts",
      "thumbnail_url": "https://storage.orshot.com/thumbnails/template-123.png",
      "pages_data": [
        {
          "name": "Page 1",
          "thumbnail_url": "https://storage.orshot.com/thumbnails/page-1.png"
        }
      ],
      "modifications": [
        {
          "key": "title",
          "id": "title",
          "type": "text",
          "helpText": "Main heading text",
          "example": "Hello World"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 45,
    "totalPages": 5
  }
}

Pagination Response Fields

FieldTypeDescription
pageIntegerCurrent page number
limitIntegerNumber of templates per page
totalIntegerTotal number of templates
totalPagesIntegerTotal number of available pages

Template Response Fields

FieldTypeDescription
idIntegerUnique identifier for the template
created_atStringTimestamp when the template was created
workspace_idStringID of the workspace the template belongs to
user_idStringID of the user who created the template
canvas_widthNumberWidth of the template canvas in pixels
canvas_heightNumberHeight of the template canvas in pixels
updated_atStringTimestamp when the template was last updated
nameStringName of the template
descriptionStringDescription of the template
thumbnail_urlStringURL to the template's thumbnail image
pages_dataArrayArray of pages (for multi-page templates)
modificationsArrayArray of available modifications for parameters

Modification Fields

Each modification object contains:

FieldTypeDescription
keyStringUnique key for the modification
idStringID of the modification
typeStringType of modification (text, image)
helpTextStringDescription of what the field is for
exampleStringExample value for the field

Error Responses

CodeDescription
400Invalid page/limit parameters
403Missing or invalid API key
403No studio templates found in workspace

On this page