Get Template Sharing

Get the public sharing state, links and stats for a studio template

Published

GET
/v1/studio/templates/{templateId}/share
curl -X GET "https://api.orshot.com/v1/studio/templates/<TEMPLATE_ID>/share" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

Overview#

Returns the current public sharing state of a studio template, including the public link, embed link, ready-to-paste embed code, and view/copy stats. These are the same links you see in the studio's Share dialog.

Endpoint
https://api.orshot.com/v1/studio/templates/:templateId/share

Path Parameters#

ParameterTypeRequiredDescription
templateIdIntegerYesThe unique ID of the studio template

Request#

JavaScript
await fetch("https://api.orshot.com/v1/studio/templates/123/share", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JSON
{
  "enabled": true,
  "allow_duplication": true,
  "share_url": "https://orshot.com/templates/shared/k3n9xq2w/preview?view=view",
  "embed_url": "https://orshot.com/templates/shared/k3n9xq2w/embed?view=view",
  "embed_code": "<iframe src=\"https://orshot.com/templates/shared/k3n9xq2w/embed?view=view\" title=\"Orshot Embed\" allow=\"clipboard-write\" style=\"width: 100%; height: 100%; min-height: 500px; border: none; border-radius: 8px;\"></iframe>",
  "stats": {
    "views": 42,
    "copies": 3
  },
  "created_at": "2026-07-11T08:05:18.491Z"
}

When sharing is disabled, enabled is false and the link fields are null.

Response Fields#

FieldTypeDescription
enabledBooleanWhether public sharing is on
allow_duplicationBooleanWhether visitors can save a copy of the template to their workspace
share_urlStringPublic preview link (null when sharing is off)
embed_urlStringEmbeddable page link (null when sharing is off)
embed_codeStringReady-to-paste iframe snippet (null when sharing is off)
stats.viewsIntegerHow many times the public page was viewed
stats.copiesIntegerHow many times the template was duplicated from the public page
created_atStringWhen sharing was first enabled

Error Responses#

Template Not Found (404)#

JSON
{
  "error": "Studio template with ID '123' not found in your workspace"
}

Unauthorized (403)#

JSON
{
  "error": "Access Forbidden: Invalid API Key"
}

Rate Limits#

  • 30 requests per minute per API key
Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 50+ integrations
  • White-label embed for your own app
  • 30 free credits — no credit card required