GET: Get Studio Template
Retrieve a specific studio template by ID
Retrieve a specific studio template by its ID, including all available modifications and template metadata.
https://api.orshot.com/v1/studio/templates/:templateId
| Parameter | Type | Required | Description |
|---|
templateId | Integer | Yes | The unique ID of the template to fetch |
await fetch("https://api.orshot.com/v1/studio/templates/123", {
method: "GET",
headers: {
"Content-Type": "application/json",
Authorization: "Bearer <ORSHOT_API_KEY>",
},
});
{
"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",
"modifications": [
{
"key": "title",
"id": "title",
"type": "text",
"helpText": "Main heading text",
"example": "Hello World"
},
{
"key": "subtitle",
"id": "subtitle",
"type": "text",
"helpText": "Subheading text",
"example": "Welcome to Orshot"
},
{
"key": "logo",
"id": "logo",
"type": "image",
"helpText": "Company logo image",
"example": "https://example.com/logo.png"
}
],
"modifications_json": {},
"pages_data": [
{
"name": "Page 1",
"thumbnail_url": "https://storage.orshot.com/thumbnails/page-1.png"
}
]
}
| Field | Type | Description |
|---|
id | Integer | Unique identifier for the template |
created_at | String | Timestamp when the template was created |
workspace_id | String | ID of the workspace the template belongs to |
user_id | String | ID of the user who created the template |
canvas_width | Number | Width of the template canvas in pixels |
canvas_height | Number | Height of the template canvas in pixels |
updated_at | String | Timestamp when the template was last updated |
name | String | Name of the template |
description | String | Description of the template |
thumbnail_url | String | URL to the template's thumbnail image |
modifications | Array | Array of available modifications for parameters |
modifications_json | Object | JSON object of modifications metadata |
pages_data | Array | Array of pages (for multi-page templates) |
Each modification object contains:
| Field | Type | Description |
|---|
key | String | Unique key for the modification |
id | String | ID of the modification |
type | String | Type of modification (text, image) |
helpText | String | Description of what the field is for |
example | String | Example value for the field |
| Code | Description |
|---|
| 400 | Missing templateId parameter |
| 403 | Missing or invalid API key |
| 403 | Studio template not found in workspace |