Get Workflow Sharing

Get the public sharing state and links for a workflow

Enterprise Only

The Workflows API is available only to first party clients like the Orshot MCP server and workspaces on the Enterprise plan. Checkout the Enterprise Pricing to get access.

Overview#

Returns the current public sharing state of a workflow, including the public page and embed links.

https://api.orshot.com/v1/workflows/:id/share

Path Parameters#

Parameter	Type	Required	Description
`id`	Integer	Yes	The unique ID of the workflow

Request#

await fetch("https://api.orshot.com/v1/workflows/83/share", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

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

Response Fields#

Field	Type	Description
`enabled`	Boolean	Whether the workflow is publicly shared
`slug`	String	The share slug (kept even while sharing is off, so links stay stable)
`includeTemplate`	Boolean	Whether people who copy the shared workflow also get its template
`url`	String	Public page link (`null` when sharing is off)
`embed_url`	String	Embeddable page link (`null` when sharing is off)

Error Responses#

Workflow Not Found (404)#

{
  "error": "Not found"
}

Rate Limits#

60 requests per minute per workspace

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