Context212Docs
Console
Get StartedTutorialsAPI ReferenceIntegrationsMCP ServerSDKsUse CasesLegal
Workspaces

List workspaces

GET
/api/v1/workspaces

List workspaces

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.

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.

Authorization

bearerAuth
AuthorizationBearer <token>

Console session token (Authorization: Bearer <session>) or product API key (Authorization: Bearer <api-key> or x-api-key). Session tokens are validated via Better Auth get-session; API keys against the shared database.

In: header

Query Parameters

datasource_type?|

The type of data source. * servicenow - ServiceNow * googledrive - Google Drive * sharepoint - SharePoint * webscrapper - WebScrapper

document_upload_method?|

Method for adding documents to this workspace: manual uploads or synced from datasources * manual - Manual * synced - Synced

group_id?integer|null
group_name?string|null
name?string|null
page?|

A page number within the paginated result set.

page_size?|

Number of results to return per page.

user_role?|
  • owner - Owner * editor - Editor * viewer - Viewer
workspace_type?|
  • shared - Shared * personal - Personal * public - Public
include_deleted?Include Deleted

When true, include soft-deleted workspaces the caller can still access.

Defaultfalse

Header Parameters

authorization?string|null
x-api-key?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces"
{  "count": 123,  "next": "http://api.example.org/accounts/?page=4",  "previous": "http://api.example.org/accounts/?page=2",  "results": [    {      "id": 0,      "name": "string",      "workspace_type": "string",      "document_upload_method": "string",      "description": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "files_count": 0,      "user_role": "owner",      "sync": {        "datasource_type": "string",        "source_name": "string",        "last_status": "string",        "updated_at": "2019-08-24T14:15:22Z",        "failed_files_count": 0,        "next_import_date": "2019-08-24T14:15:22Z",        "editable": true,        "name": "string",        "instance_url": "string",        "tenant_id": "string",        "site_name": "string",        "client_id": "string",        "filter_criteria": null      },      "scoped_api_keys": [        {          "id": "string",          "name": "string",          "prefix": "string",          "role": "string",          "created_at": "2019-08-24T14:15:22Z",          "created_by": "string",          "scope_type": "workspace"        }      ]    }  ]}

Delete a company tag DELETE

Delete a company tag Delete a company tag. This will also remove all Document-Tag associations with this tag. Requires tag deletion permission.

Create a workspace POST

Create a workspace Create a new custom workspace in the authenticated user's company. Requires the company to have `allow_user_workspace_creation` enabled, unless the caller is a company or instance administrator (who may always create workspaces). Returns **403** if workspace creation is disabled for the company and the caller is not an administrator. The creator is automatically added as OWNER.