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.

Endpoint#

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

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

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

Returned when using an expired or invalid OAuth token.

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

Returned when the API key is missing or invalid.

{
  "error": "Access Forbidden"
}

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.