Skip to main content

Get Workspace

Get a workspace by ID within an organization.

Outline

Endpoint

GET /api/v1/organizations/{org_id}/workspaces/{workspace_id}

Headers

HeaderRequiredDescription
AuthorizationYesBearer <access_token>

Path Parameters

ParameterTypeRequiredDescription
org_idintegerYesOrganization ID
workspace_idintegerYesWorkspace ID

Response

Success (200)

{
"success": true,
"data": {
"workspace": {
"id": 1,
"name": "Main Workspace",
"slug": "main-workspace",
"organization_id": 1,
"is_default": true
},
"message": "Workspace retrieved successfully"
},
"message": "Workspace retrieved successfully"
}

Permissions

  • Super admin: can get any workspace
  • Org admin: can get any workspace in their organization
  • Member with read workspace permission: can get any workspace

Features

  • Return the workspace details
  • Require authentication
  • Validate organization and workspace access permissions