Get Workspace

Retrieve the active workspace's details

Updated

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

Retrieve the workspace linked to your API key (or the active workspace of your OAuth token).

Endpoint#

Endpoint
https://api.orshot.com/v1/workspace

Request#

JavaScript
await fetch("https://api.orshot.com/v1/workspace", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JSON
{
  "data": {
    "id": 890,
    "title": "My Workspace",
    "slug": "my-workspace",
    "url": "https://orshot.com/workspace/my-workspace",
    "created_at": "2026-03-27T00:04:45.557267+00:00"
  }
}

Response Fields#

FieldTypeDescription
idNumberThe workspace's unique ID
titleStringThe workspace's display name
slugStringThe workspace's URL slug
urlStringThe workspace's dashboard URL
created_atStringWhen the workspace was created
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