List workspaces

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

{
  "count": 123,
  "results": [
    {
      "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",
      "files_count": 123,
      "sync": {
        "datasource_type": "<string>",
        "source_name": "<string>",
        "last_status": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "failed_files_count": 123,
        "next_import_date": "2023-11-07T05:31:56Z",
        "editable": true,
        "name": "<string>",
        "instance_url": "<string>",
        "tenant_id": "<string>",
        "site_name": "<string>",
        "client_id": "<string>",
        "filter_criteria": "<unknown>"
      },
      "scoped_api_keys": [
        {
          "id": "<string>",
          "name": "<string>",
          "prefix": "<string>",
          "role": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>"
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Workspaces

List workspaces

⚠️ 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), name (case-insensitive contains), group_id, group_name, user_role.

Results ordered by creation date (newest first), paginated with 20 elements per page by default.

GET

api

workspaces

List workspaces

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

{
  "count": 123,
  "results": [
    {
      "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",
      "files_count": 123,
      "sync": {
        "datasource_type": "<string>",
        "source_name": "<string>",
        "last_status": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "failed_files_count": 123,
        "next_import_date": "2023-11-07T05:31:56Z",
        "editable": true,
        "name": "<string>",
        "instance_url": "<string>",
        "tenant_id": "<string>",
        "site_name": "<string>",
        "client_id": "<string>",
        "filter_criteria": "<unknown>"
      },
      "scoped_api_keys": [
        {
          "id": "<string>",
          "name": "<string>",
          "prefix": "<string>",
          "role": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "<string>"
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

datasource_type

enum<string>

The type of data source.

servicenow - ServiceNow
googledrive - Google Drive
sharepoint - SharePoint
webscrapper - WebScrapper

Available options:

googledrive,

servicenow,

sharepoint,

webscrapper

document_upload_method

enum<string>

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

manual - Manual
synced - Synced

Available options:

manual,

synced

group_id

integer

group_name

string

name

string

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

user_role

enum<string>

owner - Owner
editor - Editor
viewer - Viewer

Available options:

editor,

owner,

viewer

workspace_type

enum<string>

shared - Shared
personal - Personal

Available options:

personal,

shared

Response

List of workspaces where the user is a member

count

integer

required

Example:

123

results

object[]

required

Show child attributes

string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"

Remove a tag from a file Create a workspace

⌘I