LIlighton
Workspaces

Retrieve a workspace

Changed on

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

Non-existent and unauthorized workspaces are treated identically (existence is not disclosed).

get/api/v3/workspaces/{id}

Request

  • Base URL
    https://api.lighton.ai
  • URL
    https://api.lighton.ai/api/v3/workspaces/{id}
  • Auth
    • HTTP bearer
    • or none

Path parameters

idinteger required

The unique identifier of the workspace.

Response

Workspace details retrieved successfully

idinteger required
namestring required
workspace_typestring required
document_upload_methodstring required
descriptionstring required
created_atstring date-time required
updated_atstring date-time required
files_countinteger required
used_storagenumber double required

Changes

  • 63ecbc61b6a9Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status