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).
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 creation date (newest first), paginated with 20 elements per page by default.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The type of data source.
servicenow- ServiceNowgoogledrive- Google Drivesharepoint- SharePointwebscrapper- WebScrapper
googledrive, servicenow, sharepoint, webscrapper Method for adding documents to this workspace: manual uploads or synced from datasources
manual- Manualsynced- Synced
manual, synced A page number within the paginated result set.
Number of results to return per page.
owner- Ownereditor- Editorviewer- Viewer
editor, owner, viewer shared- Sharedpersonal- Personalpublic- Public
personal, public, shared