---
title: "Retrieve a workspace"
method: GET
path: "/api/v3/workspaces/{id}"
tags: ["Workspaces"]
---

# Retrieve a workspace

`GET /api/v3/workspaces/{id}`

⚠️ **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.

**Sync status:** For synced workspaces, the response includes a `sync` block with `datasource_type`, `source_name`, `last_status`, `updated_at`, `failed_files_count`, and `next_import_date`. Use this field for polling the sync state.

Returns 403 for both non-existent and unauthorized workspaces.

## Path parameters

- `id` integer, required

## Response `200`

Workspace details retrieved successfully

- StandardWorkspaceV3DetailsResponse — 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
  - `files_count` integer, required
  - `user_role` union, required
    - 'owner' | 'editor' | 'viewer' — * `owner` - owner * `editor` - editor * `viewer` - viewer * `` -
    - ''
  - `used_storage` number, double, required
  - `summaries` WorkspaceSummary[], required
    - `language` string, required
    - `summary` string, required
  - `sync` WorkspaceSync, required
    - `datasource_type` string, required
    - `source_name` string, required
    - `last_status` string, required
    - `updated_at` string, date-time, nullable, required
    - `failed_files_count` integer, required
    - `next_import_date` string, date-time, nullable, required
    - `editable` boolean, required
    - `name` string, required
    - `instance_url` string, nullable, required
    - `tenant_id` string, required
    - `site_name` string, required
    - `client_id` string, required
    - `filter_criteria` unknown, required
  - `scoped_api_keys` WorkspaceScopedAPIKey[], required
    - `id` string, required
    - `name` string, required
    - `prefix` string, required
    - `role` string, required
    - `created_at` string, date-time, required
    - `created_by` string, required
    - `scope_type` 'workspace' | 'global', required — * `workspace` - workspace * `global` - global

## Other responses

- `400` — Bad Request
- `401` — Unauthenticated
- `404` — Not Found - workspace not found or user is not a member

---

[API](https://skmtc.dev/lighton/apis/lighton-api.md) · [All operations](https://skmtc.dev/lighton/apis/lighton-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lighton/lighton-api/revisions/86c57e94ef15/schema)