Sign in

v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
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.

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.

get/api/v3/workspaces

Query parameters

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

The type of data source.

  • servicenow - ServiceNow
  • googledrive - Google Drive
  • sharepoint - SharePoint
  • webscrapper - WebScrapper
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
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"
}