Get Workspace

`GET /api/workspaces/{id}`

Path Parameters

Parameter	Type	Description
`id`	string	The workspace ID

Example

curl https://api.scalereach.ai/api/workspaces/znrje9lkcidmmaiziti \
  -H "Authorization: Bearer sr_live_YOUR_KEY"

Response `200`

{
  "id": "znrje9lkcidmmaiziti",
  "name": "My Workspace",
  "slug": "my-workspace",
  "description": null,
  "logo": "https://cdn.scalereach.ai/workspaces/logo.png",
  "plan": "pro",
  "billingCycle": "monthly",
  "ownerId": "user_abc123",
  "role": "owner",
  "createdAt": "2026-01-21T18:41:34.819Z",
  "updatedAt": "2026-03-12T09:49:24.046Z"
}

Response fields

Field	Type	Description
`id`	string	The workspace ID, used as `workspaceId` in other endpoints.
`name`	string	Display name.
`slug`	string	URL-safe identifier used in dashboard links.
`description`	string or null	Optional description.
`logo`	string or null	URL of the workspace logo.
`plan`	string	The current plan, for example `free`, `starter`, `pro` or `pro-plus`.
`billingCycle`	string	`monthly` or `annual` for paid plans, and `null` on the free plan.
`ownerId`	string	The user who owns the workspace.
`role`	string	Your role in this workspace, such as `owner` or `member`.
`createdAt`, `updatedAt`	string	ISO 8601 timestamps.

API keys only see their own workspace

Every API key is created inside one workspace. If you pass the ID of a different workspace, the request fails with 403 and the message "API key does not have access to this workspace", even if your own user account belongs to both. To work with another workspace, create a key inside that workspace from Workspace Settings → API Keys.

Errors

Status	When it happens
`401`	The API key is missing, invalid or expired.
`403`	The ID belongs to a workspace your key does not cover, or you are not a member of it.
`404`	No workspace exists with that ID.
`500`	The workspace could not be loaded. Retry the request.

Example: check the plan before submitting a video

import requests, os

headers = {"Authorization": f"Bearer {os.environ['SCALEREACH_API_KEY']}"}
base = "https://api.scalereach.ai/api"

workspace_id = requests.get(f"{base}/workspaces", headers=headers).json()[0]["id"]
ws = requests.get(f"{base}/workspaces/{workspace_id}", headers=headers).json()
print(f'{ws["name"]} is on the {ws["plan"]} plan ({ws["billingCycle"]}), your role: {ws["role"]}')

On this page