Workspaces

List workspaces

Changed on

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

Get the list of accessible workspaces for the authenticated user. Returns workspaces where the user is set as member (through any group: private, company, or custom). Please use instance or company level endpoints to access the workspaces as admin.

Filtering: All users see only workspaces where they are members. Admin users should use /api/v3/instance/workspaces or /api/v3/company/workspaces for administrative access.

Supported query filters: workspace_type, document_upload_method, datasource_type (googledrive, sharepoint, servicenow, webscrapper, smb), name (case-insensitive contains), group_id, group_name, user_role.

API keys: scoped_api_keys lists your own non-revoked keys that can access the workspace. Each entry has a scope_type: workspace for keys explicitly scoped to it (listed first, with their per-workspace role), or global for keys with no scope rows that implicitly reach every workspace (their role mirrors your own role on the workspace).

Taxonomy: Each workspace includes a taxonomy field summarizing content type classification. classified_files_rate is the proportion of documents with at least one content type (0-to-1 ratio). root_content_types lists top-level content type families with document counts. A workspace holding documents that are all unclassified reports a rate of 0.0 with an empty root_content_types; the whole taxonomy object is null only when the workspace has no documents.

Results ordered by name ascending by default — pass ordering to change it. Paginated with 20 elements per page by default.

get/api/v3/workspaces

Request

  • Base URL
    https://api.lighton.ai
  • URL
    https://api.lighton.ai/api/v3/workspaces
  • Auth
    HTTP bearer

Query parameters

datasource_type'googledrive' | 'servicenow' | 'sharepoint' | 'smb' | 'webscrapper'

The type of data source.

  • servicenow - ServiceNow
  • googledrive - Google Drive
  • sharepoint - SharePoint
  • webscrapper - WebScrapper
  • smb - SMB
document_upload_method'manual' | 'synced'

Method for adding documents to this workspace: manual uploads or synced from datasources

  • manual - Manual
  • synced - Synced
group_idinteger
group_namestring
namestring
ordering'-created_at' | '-name' | '-updated_at' | 'created_at' | 'name' | 'updated_at'

Order the results by name, created_at or updated_at. Prefix the field with - for descending order (e.g. -created_at). Defaults to name; entries sharing a name are ordered newest-first.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

user_role'editor' | 'owner' | 'viewer'
  • owner - Owner
  • editor - Editor
  • viewer - Viewer
workspace_type'personal' | 'public' | 'shared'
  • shared - Shared
  • personal - Personal
  • public - Public

Response

List of workspaces where the user is a member

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

    • info

      added the new optional query request parameter ordering

    • info

      added the new enum value smb to the query request parameter datasource_type

    • 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

    • info

      added the required property // to the response with the status