Get a Template's Approval Status

Tells you where a template stands: which approval flows it is in, its stage in each and who it waits on.

Updated Sep 29, 2026

GET

/v1/studio/templates/{templateId}/approval

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

const res = await fetch("https://api.orshot.com/v1/studio/templates/<TEMPLATE_ID>/approval", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

const data = await res.json();

$ch = curl_init("https://api.orshot.com/v1/studio/templates/<TEMPLATE_ID>/approval");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <ORSHOT_API_KEY>",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://api.orshot.com/v1/studio/templates/<TEMPLATE_ID>/approval")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Enterprise Only

The Approvals API is available on Enterprise plans, or through first-party apps (the Orshot app and the Orshot MCP server). This endpoint needs read access. See Enterprise pricing to get access.

Tells you where a template stands: which approval flows it is in, its stage in each and who it waits on. It also says whether the design is locked and which outputs (image, pdf, video) may render through the API. Downloads from the studio and the embed editor are never blocked. Each flow's viewer says whether you may approve, request changes, move or comment there, and why not. Call it when a render fails with template_not_approved or before editing a template.

Endpoint#

Endpoint

https://api.orshot.com/v1/studio/templates/:templateId/approval

Path Parameters#

Parameter	Type	Required	Description
`templateId`	Integer	Yes	The template's id.

Headers#

Header	Required	Description
`Authorization`	Yes	`Bearer <API key or OAuth token>`
`x-workspace-id`	No	OAuth tokens with several workspaces: the workspace to act in. API keys ignore it.
`X-Orshot-User-Id`	No	API keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below.
`X-Session-Id`	No	Groups the calls of one agent or MCP session in the activity history.

Acting for a Team Member#

With an API key, you can send X-Orshot-User-Id with the user id of an owner, admin or member of the workspace to make this call for them. The answer then follows both the key's access level and that person's own access. See acting for a team member.

Request#

JavaScript

await fetch("https://api.orshot.com/v1/studio/templates/101/approval", {
  headers: { Authorization: "Bearer <ORSHOT_API_KEY>" },
});

JSON

{
  "status": {
    "templateId": 101,
    "currentVersion": "5b8e2f7a-3c1d-4e9b-a6f0-7d2c8e1b4a93",
    "flows": [
      {
        "flow": {
          "id": 1,
          "slug": "brand-and-legal",
          "name": "Brand and legal",
          "blocksRenders": true
        },
        "stage": {
          "id": 2,
          "slug": "brand-review",
          "name": "Brand review",
          "category": "review",
          "color": null
        },
        "item": {
          "id": 1,
          "revision": 2,
          "reviewRound": 1
        },
        "overPlanLimit": false,
        "approvals": {
          "mode": "any",
          "required": 1,
          "approvedBy": [],
          "changesRequestedBy": [],
          "submitter": {
            "id": "b5d2e8f1-7a3c-4b69-9e0d-3c8a1f6b2e45"
          }
        },
        "changesRequested": null,
        "viewer": {
          "can": {
            "approve": false,
            "requestChanges": false,
            "move": true,
            "comment": true
          },
          "reasons": {
            "approve": "You're not an approver in the 'Brand review' stage. Priya can approve it.",
            "requestChanges": "You're not an approver in the 'Brand review' stage. Priya can approve it."
          }
        },
        "editSession": null,
        "editChoice": null
      }
    ],
    "canRender": {
      "image": false,
      "pdf": false,
      "video": false
    },
    "blockers": [
      {
        "flow": {
          "id": 1,
          "slug": "brand-and-legal",
          "name": "Brand and legal"
        },
        "stage": {
          "id": 2,
          "slug": "brand-review",
          "name": "Brand review",
          "category": "review"
        },
        "reason": "not_in_render_stage",
        "waitingOn": [
          "Priya Shah"
        ]
      }
    ],
    "locked": true
  }
}

Response Fields#

Responds 200 with:

Field	Type	Description
`status`	Object	One TemplateApprovalStatus, fields below.
`status.templateId`	Integer	The template's id.
`status.currentVersion`	String	The design version to send as reviewedVersion. Can be `null`.
`status.flows`	Array	`[{ flow, stage, item, overPlanLimit, approvals, changesRequested, viewer }]`. Every approval flow the template is in (that you can see). stage is `{ id, slug, name, category, color }` (color is null when the stage has none). overPlanLimit is true when that flow is past the plan's limit of approval flows: nothing can be changed there, and it blocks nothing. viewer is what you may do with the template there now: can `{ approve, requestChanges, move, comment }` booleans, and reasons with the refusal's words for each false one.
`status.canRender`	Object	`{ image, pdf, video }`. Booleans for API renders (flows past the plan's limit block nothing). Downloads from the studio and the embed editor are never blocked.
`status.blockers`	Array	Why a render is refused, one object per blocking flow: `flow`, `stage`, `reason` (`not_in_render_stage`, `design_only`, `output_not_approved`, `edited_since_approval`, `approved_version_missing`, `approval_missing`), and when known `waitingOn` (who can approve), `renderStage` (a stage that renders and that the template can move to from where it is) and, for `design_only`, `nextStage` (the review it needs next). The same objects a blocked render returns in its `403` body.
`status.locked`	Boolean	The design cannot be edited in its current stage (a flow past the plan's limit locks nothing).

Error Responses#

Every error has the same body: error, code, message and helpUrl, plus the fields that apply (required, role, context, blockers, violations, issues, current). Branch on error; code is more specific. See the error reference.

Status Code	Error	Description
401	`oauth_token_invalid`	The OAuth token is invalid, expired or revoked.
403	`api_key_missing`	No `Authorization: Bearer` header.
403	`permission_denied`	You don't have access to do this. Ask an owner or admin. `code` names the capability, for example `approval.item.decide_denied`; `required` and `role` say what was missing. With `code: insufficient_scope`: the OAuth token lacks `workspace:approvals:read`. With `code: approval.member_header_not_member`: `X-Orshot-User-Id` names someone who isn't an owner, admin or member of the workspace now. With `code: approval.member_header_not_allowed`: an OAuth token sent `X-Orshot-User-Id`.
403	`plan_required`	The workspace's plan doesn't include Approvals, or doesn't include this part of it.
403	`enterprise_api_required`	Using approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on.
404	`not_found`	This doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access.
422	`validation_failed`	Some fields aren't valid: the fields listed in issues. `issues` lists each field with a path and a reason.
422	`validation_failed`	With `code: approval.member_header_invalid`: `X-Orshot-User-Id` isn't a user id.
429	`rate_limit_exceeded`	More than 120 approvals requests in a minute from one person or key. Wait for Retry-After.
503	`approvals_unavailable`	Approvals aren't available right now. Try again in a moment. Also returned while approvals are not switched on for the API.

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
100 free credits a month, no credit card required