---
title: "List workspaces"
method: GET
path: "/api/v3/workspaces"
tags: ["Workspaces"]
---

# List workspaces

`GET /api/v3/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`.

**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).

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

## Query parameters

- `datasource_type` 'googledrive' | 'servicenow' | 'sharepoint' | 'webscrapper'
- `document_upload_method` 'manual' | 'synced'
- `group_id` integer
- `group_name` string
- `name` string
- `page` integer
- `page_size` integer
- `user_role` 'editor' | 'owner' | 'viewer'
- `workspace_type` 'personal' | 'public' | 'shared'

## Response `200`

List of workspaces where the user is a member

- PaginatedStandardWorkspaceV3ListResponseList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` StandardWorkspaceV3ListResponse[], required
    - `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 * `` -
      - ''
    - `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 - Invalid query parameters (unsupported parameter, invalid enum values, etc.)
- `401` — Unauthenticated - Missing or invalid API key/session cookie

---

[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)