Retrieve a workspace

⚠️ ALPHA ENDPOINT - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Retrieve a workspace by ID. Returns workspace in V3 format.

Access: Instance-level users (Sys Admin, Account Manager, Admin, DPO Admin) can retrieve any workspace. Company-level users (Company Admin, Company DPO) can retrieve workspaces in their company. Regular users can retrieve workspaces where they are members.

Member Visibility: Instance-level users and company-level users see all members. Workspace OWNER sees members. EDITOR and VIEWER do not see members.

Returns 403 for both non-existent and unauthorized workspaces.

GET /api/v3/workspaces/{id}

Retrieve a workspace

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/workspaces/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 123,
  "name": "<string>",
  "workspace_type": "<string>",
  "document_upload_method": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_role": "<string>",
  "used_storage": 123,
  "files_count": 123,
  "summaries": [
    {
      "language": "<string>",
      "summary": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · integer · required

The unique identifier of the workspace.

Response

200

application/json

Workspace details retrieved successfully

V3 Response serializer for company workspace creation and retrieval.

id · integer · required

name · string · required

workspace_type · string · required

document_upload_method · string · required

description · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

user_role · string · required · read-only

used_storage · number<double> · required

files_count · integer · required

summaries · object[] · required · read-only

Show child attributes