Workspaces

Manage workspaces, members, roles, invitations, and preferences.

Get Workspace Preferences

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Responses

200

A successful response.

application/json

Represents workspace-specific settings or preferences.

namestringOptional

support_team_accessbooleanOptional

Support team access to workspace for debugging issues.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/preferences

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/preferences HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "support_team_access": true,
  "general": {
    "time_zone": "text",
    "time_format": "TIME_FORMAT_UNSPECIFIED",
    "date_format": "DATE_FORMAT_UNSPECIFIED",
    "decimal_symbol": "DECIMAL_SYMBOL_UNSPECIFIED",
    "decimal_places": 1,
    "measurement_system": "MEASUREMENT_SYSTEM_UNSPECIFIED"
  }
}

List Workspace User Invites

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Query parameters

page_sizeinteger · int32Optional

The maximum number of invitations to return. If unspecified, at most 50 invitations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListWorkspaceUserInvites call. Provide this to retrieve the subsequent page.

Responses

200

A successful response.

application/json

Response message for ListWorkspaceUserInvites.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListWorkspaceUserInvites to get the next page of results.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/invites

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/invites HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "invitations": [
    {
      "email": "text",
      "invitation_id": "text"
    }
  ],
  "next_page_token": "text"
}

List Workspace Roles

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Query parameters

page_sizeinteger · int32Optional

The maximum number of roles to return. If unspecified, at most 50 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListWorkspaceRoles call. Provide this to retrieve the subsequent page.

Responses

200

A successful response.

application/json

Response message for ListWorkspaceRoles.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListWorkspaceRoles to get the next page of results.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/roles

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/roles HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "roles": [
    {
      "name": "text",
      "title": "text",
      "description": "text",
      "permissions": [
        "text"
      ]
    }
  ],
  "next_page_token": "text"
}

List Workspace Users

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Query parameters

page_sizeinteger · int32Optional

The maximum number of users to return. If unspecified, at most 50 users will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListWorkspaceUsers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaceUsers must match the call that provided the page token.

filterstringOptional

Optional filter string following AIP-160 filtering standards. Supported filter fields:

• role: Filter by role name (case-insensitive). Example: role="Workspace Viewer"
• role_scope: Filter by role scope. Values: "organization" or "workspace". Example: role_scope=workspace
• search: Search by user display name or email (partial match). Example: search:"john"

order_bystringOptional

Optional comma-separated list of fields to order by, following AIP-132. Supported fields: display_name, email, created_time, updated_time Example: "display_name,created_time desc" Default ordering is by created_time descending if not specified.

Responses

200

A successful response.

application/json

Response message for listing users in a workspace.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListWorkspaceUsers to get the next page of results. If this field is empty, it means there are no more results.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/users

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id}/users HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "users": [
    {
      "user": {
        "name": "text",
        "display_name": "text",
        "email": "text"
      },
      "roles": [
        {
          "name": "text",
          "role_scope": "ROLE_SCOPE_UNSPECIFIED"
        }
      ]
    }
  ],
  "next_page_token": "text"
}

Count Workspace Users

post

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

Body

application/json

Request message for counting users in specific workspaces.

workspace_idsstring[]Required

Responses

200

A successful response.

application/json

Response message for counting users in specific workspaces.

default

An unexpected error response.

application/json

post

/api/v1/organizations/{organization_id}/workspaces:countUsers

HTTPcURLJavaScriptPython

POST /api/v1/organizations/{organization_id}/workspaces:countUsers HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "workspace_ids": [
    "text"
  ]
}

{
  "workspace_user_counts": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Get Workspace

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

workspace_idstringRequired

Responses

200

A successful response.

application/json

A Workspace is a container for agents within an organization.

namestringOptional

The resource name of the workspace. Format: organizations/{organization}/workspaces/{workspace} This field is assigned by the server at creation and is immutable thereafter. Clients may include this field in Get/Update/Delete requests to identify the resource.

titlestringRequired

The user-defined display name for the workspace. This corresponds to the name column in the database.

workspace_iconstringOptional

The workspace icon data. This field contains the identifier of the workspace icon.

workspace_icon_colorstringOptional

The color of the workspace icon.

create_timestring · date-timeRead-onlyOptional

The timestamp when the workspace was created.

update_timestring · date-timeRead-onlyOptional

The timestamp when the workspace was last updated.

creator_display_namestringRead-onlyOptional

The display name of the user who created the workspace.

creator_emailstringRead-onlyOptional

The email address of the user who created the workspace.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/workspaces/{workspace_id}

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/workspaces/{workspace_id} HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "title": "text",
  "workspace_icon": "text",
  "workspace_icon_color": "text",
  "create_time": "2026-03-12T11:52:59.301Z",
  "update_time": "2026-03-12T11:52:59.301Z",
  "creator_display_name": "text",
  "creator_email": "text"
}

List Workspaces

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

Query parameters

page_sizeinteger · int32Optional

The maximum number of workspaces to return. If unspecified, at most 50 workspaces will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

filterstringOptional

Optional. A filter expression to constrain the workspaces returned. The expression follows the syntax defined in AIP-160. Supported fields for filtering:

• title: The display name of the workspace

Examples:

• title = "My Workspace" - exact match
• title : "workspace" - contains match (case-insensitive)

order_bystringOptional

Optional comma-separated list of fields to order by, following AIP-132. Supported fields: title, create_time, update_time Example: "title", "create_time desc", "update_time desc,title" Default ordering is by create_time descending if not specified.

Responses

200

A successful response.

application/json

Response message for listing workspaces.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to ListWorkspaces to get the next page of results. If this field is empty, it means there are no more results.

default

An unexpected error response.

application/json

get

/api/v1/organizations/{organization_id}/workspaces

HTTPcURLJavaScriptPython

GET /api/v1/organizations/{organization_id}/workspaces HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspaces": [
    {
      "name": "text",
      "title": "text",
      "workspace_icon": "text",
      "workspace_icon_color": "text",
      "create_time": "2026-03-12T11:52:59.301Z",
      "update_time": "2026-03-12T11:52:59.301Z",
      "creator_display_name": "text",
      "creator_email": "text"
    }
  ],
  "next_page_token": "text"
}

Current User Organization Workspaces

get

Authorizations

BearerAuth

AuthorizationstringRequired

Personal Access Token.

Path parameters

organization_idstringRequired

Query parameters

page_sizeinteger · int32Optional

The maximum number of workspaces to return. If unspecified, at most 50 workspaces will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringOptional

A page token, received from a previous CurrentUserOrganizationWorkspaces call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CurrentUserOrganizationWorkspaces must match the call that provided the page token.

filterstringOptional

Optional filter string following AIP-160 filtering standards. Example: "title='Development'"

Responses

200

A successful response.

application/json

Response message for listing workspaces for the current user within a specific organization.

next_page_tokenstringOptional

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to CurrentUserOrganizationWorkspaces to get the next page of results. If this field is empty, it means there are no more results.

default

An unexpected error response.

application/json

get

/api/v1/me/organizations/{organization_id}/workspaces

HTTPcURLJavaScriptPython

GET /api/v1/me/organizations/{organization_id}/workspaces HTTP/1.1
Host: app.us-1.kognitos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user_workspaces": [
    {
      "name": "text",
      "title": "text",
      "workspace_icon": "text",
      "workspace_icon_color": "text",
      "create_time": "2026-03-12T11:52:59.301Z",
      "update_time": "2026-03-12T11:52:59.301Z",
      "creator_display_name": "text",
      "creator_email": "text"
    }
  ],
  "next_page_token": "text"
}