Get Profile and Workspaces
Retrieve your profile and workspace details using your API key or OAuth token
Updated
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/meRequest#
await fetch("https://api.orshot.com/v1/me", {
method: "GET",
headers: {
Authorization: "Bearer <ORSHOT_API_KEY>",
},
});Response Fields#
| Field | Type | Description |
|---|---|---|
user_id | String | Your unique user ID |
email | String | Your email address |
name | String | Your full name |
workspaces | Array | List of workspaces accessible with this token |
workspaces[].id | Number | Workspace ID |
workspaces[].name | String | Workspace name |
workspaces[].slug | String | Workspace slug |
plan | Object | Your current plan and live usage |
plan.credits | Object | Render credits used vs included this period |
plan.ai_credits | Object | AI credits used vs included this period |
plan.limits | Object | Member, workspace and rate limits |
plan.workflows | Object | What your plan includes for Workflows |
plan.embed | Object | What your plan includes for Orshot Embed |
plan.video | Object | Whether video rendering is included |
Error Responses#
Unauthorized (401)#
Returned when using an expired or invalid OAuth token.
{
"error": "Access Forbidden",
"message": "Invalid or expired OAuth token",
"code": "oauth_token_invalid"
}Forbidden (403)#
Returned when the API key is missing or invalid.
{
"error": "Access Forbidden"
}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