Get Profile and Workspaces

Retrieve your profile and workspace details using your API key or OAuth token

Retrieve your user profile and associated workspaces. Works with both API keys and OAuth access tokens.

  • API Key: Returns the single workspace linked to the key
  • OAuth Token: Returns all workspaces the token has been granted access to

Endpoint

https://api.orshot.com/v1/me

Request

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

Response Fields

FieldTypeDescription
user_idStringYour unique user ID
emailStringYour email address
nameStringYour full name
workspacesArrayList of workspaces accessible with this token
workspaces[].idNumberWorkspace ID
workspaces[].nameStringWorkspace name
workspaces[].slugStringWorkspace slug

Error Responses

Unauthorized (401)

Returned when using an expired or invalid OAuth token.

{
  "error": "Access Forbidden",
  "message": "OAuth token expired or invalid"
}

Forbidden (403)

Returned when the API key is missing or invalid.

{
  "error": "Access Forbidden"
}

Rate Limits

  • 20 requests per minute per API key

All Set? Let's Start Automating

Get Your API Key →
  • Image, PDF and Video Generation via API
  • Canva like editor with AI and smart features
  • No-Code Integrations (Zapier, Make, n8n etc.)
  • Embed Orshot Studio in your app
  • Start Free. No credit card required. Cancel anytime.