# Workspaces

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

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/preferences

> Get Workspace Preferences

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1WorkspacePreferences":{"type":"object","properties":{"name":{"type":"string","title":"The resource name of the workspace preferences.\nFormat: `organizations/{organization}/workspaces/{workspace}/preferences`"},"support_team_access":{"type":"boolean","description":"Support team access to workspace for debugging issues."},"general":{"$ref":"#/components/schemas/v1GeneralPreferences"}},"description":"Represents workspace-specific settings or preferences."},"v1GeneralPreferences":{"type":"object","properties":{"time_zone":{"type":"string","description":"The time zone preference.\nShould be an IANA timezone identifier (e.g., \"America/New_York\", \"Europe/London\", \"UTC\")."},"time_format":{"$ref":"#/components/schemas/v1TimeFormat"},"date_format":{"$ref":"#/components/schemas/v1DateFormat"},"decimal_symbol":{"$ref":"#/components/schemas/v1DecimalSymbol"},"decimal_places":{"type":"integer","format":"int32","description":"The number of digits after decimal point."},"measurement_system":{"$ref":"#/components/schemas/v1MeasurementSystem"}},"description":"General preferences for display and formatting.\nUsed by both workspace and organization preferences."},"v1TimeFormat":{"type":"string","enum":["TIME_FORMAT_UNSPECIFIED","TIME_FORMAT_12_HOUR","TIME_FORMAT_24_HOUR"],"default":"TIME_FORMAT_UNSPECIFIED","description":"Supported time formats.\n\n - TIME_FORMAT_UNSPECIFIED: Unspecified time format.\n - TIME_FORMAT_12_HOUR: 12-hour format (1:00 PM).\n - TIME_FORMAT_24_HOUR: 24-hour format (13:00)."},"v1DateFormat":{"type":"string","enum":["DATE_FORMAT_UNSPECIFIED","DATE_FORMAT_DD_MM_YYYY_SLASH","DATE_FORMAT_MM_DD_YYYY_SLASH","DATE_FORMAT_YYYY_MM_DD_DASH","DATE_FORMAT_DD_MM_YYYY_DASH","DATE_FORMAT_MM_DD_YYYY_DASH","DATE_FORMAT_YYYY_MM_DD_SLASH","DATE_FORMAT_DD_MM_YYYY_DOT","DATE_FORMAT_MM_DD_YYYY_DOT","DATE_FORMAT_YYYY_MM_DD_DOT","DATE_FORMAT_DD_MMM_YYYY","DATE_FORMAT_MMM_DD_YYYY","DATE_FORMAT_DD_MMMM_YYYY","DATE_FORMAT_MMMM_DD_YYYY"],"default":"DATE_FORMAT_UNSPECIFIED","description":"Supported date formats.\n\n - DATE_FORMAT_UNSPECIFIED: Unspecified date format.\n - DATE_FORMAT_DD_MM_YYYY_SLASH: DD/MM/YYYY format.\n - DATE_FORMAT_MM_DD_YYYY_SLASH: MM/DD/YYYY format.\n - DATE_FORMAT_YYYY_MM_DD_DASH: YYYY-MM-DD format (ISO 8601).\n - DATE_FORMAT_DD_MM_YYYY_DASH: DD-MM-YYYY format.\n - DATE_FORMAT_MM_DD_YYYY_DASH: MM-DD-YYYY format.\n - DATE_FORMAT_YYYY_MM_DD_SLASH: YYYY/MM/DD format.\n - DATE_FORMAT_DD_MM_YYYY_DOT: DD.MM.YYYY format (European style).\n - DATE_FORMAT_MM_DD_YYYY_DOT: MM.DD.YYYY format.\n - DATE_FORMAT_YYYY_MM_DD_DOT: YYYY.MM.DD format.\n - DATE_FORMAT_DD_MMM_YYYY: DD MMM YYYY format (e.g., 15 Jan 2024).\n - DATE_FORMAT_MMM_DD_YYYY: MMM DD, YYYY format (e.g., Jan 15, 2024).\n - DATE_FORMAT_DD_MMMM_YYYY: DD MMMM YYYY format (e.g., 15 January 2024).\n - DATE_FORMAT_MMMM_DD_YYYY: MMMM DD, YYYY format (e.g., January 15, 2024)."},"v1DecimalSymbol":{"type":"string","enum":["DECIMAL_SYMBOL_UNSPECIFIED","DECIMAL_SYMBOL_PERIOD","DECIMAL_SYMBOL_COMMA"],"default":"DECIMAL_SYMBOL_UNSPECIFIED","description":"Supported decimal symbols.\n\n - DECIMAL_SYMBOL_UNSPECIFIED: Unspecified decimal symbol.\n - DECIMAL_SYMBOL_PERIOD: Period (.) as decimal separator.\n - DECIMAL_SYMBOL_COMMA: Comma (,) as decimal separator."},"v1MeasurementSystem":{"type":"string","enum":["MEASUREMENT_SYSTEM_UNSPECIFIED","MEASUREMENT_SYSTEM_METRIC","MEASUREMENT_SYSTEM_IMPERIAL"],"default":"MEASUREMENT_SYSTEM_UNSPECIFIED","description":"Supported measurement systems.\n\n - MEASUREMENT_SYSTEM_UNSPECIFIED: Unspecified measurement system.\n - MEASUREMENT_SYSTEM_METRIC: Metric system.\n - MEASUREMENT_SYSTEM_IMPERIAL: Imperial system."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/preferences":{"get":{"summary":"Get Workspace Preferences","operationId":"GetWorkspacePreferences","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1WorkspacePreferences"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/invites

> List Workspace User Invites

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListWorkspaceUserInvitesResponse":{"type":"object","properties":{"invitations":{"type":"array","items":{"$ref":"#/components/schemas/v1UserInvitation"},"description":"The list of pending user invitations."},"next_page_token":{"type":"string","description":"A token to retrieve the next page of results.\nPass this value in the page_token field in the subsequent call to\nListWorkspaceUserInvites to get the next page of results."}},"description":"Response message for ListWorkspaceUserInvites."},"v1UserInvitation":{"type":"object","properties":{"email":{"type":"string","description":"The user's email address."},"invitation_id":{"type":"string","description":"The invitation ID."}},"description":"A UserInvitation represents a pending invitation with user email and invitation ID."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/invites":{"get":{"summary":"List Workspace User Invites","operationId":"ListWorkspaceUserInvites","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListWorkspaceUserInvitesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of invitations to return.\nIf unspecified, at most 50 invitations will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","description":"A page token, received from a previous ListWorkspaceUserInvites call.\nProvide this to retrieve the subsequent page.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/roles

> List Workspace Roles

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListWorkspaceRolesResponse":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/v1Role"},"description":"The list of roles in the workspace."},"next_page_token":{"type":"string","description":"A token to retrieve the next page of results.\nPass this value in the page_token field in the subsequent call to\nListWorkspaceRoles to get the next page of results."}},"description":"Response message for ListWorkspaceRoles."},"v1Role":{"type":"object","properties":{"name":{"type":"string","title":"Resource name of the role.\nFormat: organizations/{organization}/roles/{role} (org-level)\nFormat: organizations/{organization}/workspaces/{workspace}/roles/{role} (workspace-level)"},"title":{"type":"string","description":"Human-readable title of the role (e.g., \"Administrator\", \"Editor\")."},"description":{"type":"string","description":"Description of what this role grants."},"permissions":{"type":"array","items":{"type":"string"},"title":"List of permission strings this role grants.\nFormat: \"action:Resource\" (e.g., \"create:Automation\", \"read:Workspace\")","readOnly":true}},"description":"A Role represents a concrete, assignable role that can be assigned to users.\nRoles can be created from RoleTemplates or as standalone custom roles.","required":["title"]},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/roles":{"get":{"summary":"List Workspace Roles","operationId":"ListWorkspaceRoles","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListWorkspaceRolesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of roles to return.\nIf unspecified, at most 50 roles will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","description":"A page token, received from a previous ListWorkspaceRoles call.\nProvide this to retrieve the subsequent page.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}/users

> List Workspace Users

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListWorkspaceUsersResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/v1UserWithRoles"},"description":"The list of users in the workspace with their roles."},"next_page_token":{"type":"string","description":"A token to retrieve the next page of results.\nPass this value in the `page_token` field in the subsequent call to\n`ListWorkspaceUsers` to get the next page of results. If this field is\nempty, it means there are no more results."}},"description":"Response message for listing users in a workspace."},"v1UserWithRoles":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/v1UserBasicInfo"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/v1RoleBasicInfo"},"description":"The user's assigned roles.\nEach role includes its scope (organization or workspace)."}},"description":"A user with their assigned roles.\nThis type is reusable for both organization and workspace user listing APIs.\nThe RoleScope field in each role indicates whether the role is org-level or workspace-level."},"v1UserBasicInfo":{"type":"object","properties":{"name":{"type":"string","title":"The unique resource name of the user basic info.\nFormat: `organizations/{organization}/users/{user_basic_info}`"},"display_name":{"type":"string","description":"The user's display name."},"email":{"type":"string","description":"The user's email address."}},"description":"Contains basic information about a user.\nThis is a lightweight representation used when full user details are not needed."},"v1RoleBasicInfo":{"type":"object","properties":{"name":{"type":"string","description":"The role name (e.g., \"workspace-admin\", \"org-admin\", or custom role name)."},"role_scope":{"$ref":"#/components/schemas/v1RoleScope"}},"title":"Lightweight role information following the UserBasicInfo pattern.\nNote: RoleScope is imported from rbac.proto"},"v1RoleScope":{"type":"string","enum":["ROLE_SCOPE_UNSPECIFIED","ROLE_SCOPE_ORGANIZATION","ROLE_SCOPE_WORKSPACE"],"default":"ROLE_SCOPE_UNSPECIFIED","description":"Defines the scope at which a role can be applied.\n\n - ROLE_SCOPE_UNSPECIFIED: Unspecified role scope.\n - ROLE_SCOPE_ORGANIZATION: Role applies at the organization level.\n - ROLE_SCOPE_WORKSPACE: Role applies at the workspace level."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/users":{"get":{"summary":"List Workspace Users","operationId":"ListWorkspaceUsers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListWorkspaceUsersResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of users to return.\nIf unspecified, at most 50 users will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","description":"A page token, received from a previous `ListWorkspaceUsers` call.\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListWorkspaceUsers` must match\nthe call that provided the page token.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"Optional filter string following AIP-160 filtering standards.\nSupported filter fields:\n- `role`: Filter by role name (case-insensitive). Example: `role=\"Workspace Viewer\"`\n- `role_scope`: Filter by role scope. Values: \"organization\" or \"workspace\". Example: `role_scope=workspace`\n- `search`: Search by user display name or email (partial match). Example: `search:\"john\"`","in":"query","required":false,"schema":{"type":"string"}},{"name":"order_by","description":"Optional comma-separated list of fields to order by, following AIP-132.\nSupported fields: display_name, email, created_time, updated_time\nExample: \"display_name,created_time desc\"\nDefault ordering is by created_time descending if not specified.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```

## POST /api/v1/organizations/{organization\_id}/workspaces:countUsers

> Count Workspace Users

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1CountWorkspaceUsersResponse":{"type":"object","properties":{"workspace_user_counts":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"A map of workspace IDs to their respective user counts.\nThe key is the workspace ID, and the value is the count of users in that workspace."}},"description":"Response message for counting users in specific workspaces."},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}},"CountWorkspaceUsersBody":{"type":"object","properties":{"workspace_ids":{"type":"array","items":{"type":"string"},"title":"The list of workspace IDs to get user counts for.\nEach workspace_id should be the workspace identifier (not the full resource name).\nThe full workspace resource names will be constructed as:\norganizations/{organization}/workspaces/{workspace_id}"}},"description":"Request message for counting users in specific workspaces.","required":["workspace_ids"]}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces:countUsers":{"post":{"summary":"Count Workspace Users","operationId":"CountWorkspaceUsers","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1CountWorkspaceUsersResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountWorkspaceUsersBody"}}},"required":true},"tags":["Workspaces"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces/{workspace\_id}

> Get Workspace

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1Workspace":{"type":"object","properties":{"name":{"type":"string","description":"The resource name of the workspace.\nFormat: organizations/{organization}/workspaces/{workspace}\nThis field is assigned by the server at creation and is immutable thereafter.\nClients may include this field in Get/Update/Delete requests to identify the resource."},"title":{"type":"string","description":"The user-defined display name for the workspace.\nThis corresponds to the `name` column in the database."},"workspace_icon":{"type":"string","description":"The workspace icon data.\nThis field contains the identifier of the workspace icon."},"workspace_icon_color":{"type":"string","description":"The color of the workspace icon."},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the workspace was created.","readOnly":true},"update_time":{"type":"string","format":"date-time","description":"The timestamp when the workspace was last updated.","readOnly":true},"creator_display_name":{"type":"string","description":"The display name of the user who created the workspace.","readOnly":true},"creator_email":{"type":"string","description":"The email address of the user who created the workspace.","readOnly":true}},"description":"A Workspace is a container for agents within an organization.","required":["title"]},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces/{workspace_id}":{"get":{"summary":"Get Workspace","operationId":"GetWorkspace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Workspace"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```

## GET /api/v1/organizations/{organization\_id}/workspaces

> List Workspaces

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1ListWorkspacesResponse":{"type":"object","properties":{"workspaces":{"type":"array","items":{"$ref":"#/components/schemas/v1Workspace"},"description":"The list of workspaces."},"next_page_token":{"type":"string","description":"A token to retrieve the next page of results.\nPass this value in the `page_token` field in the subsequent call to\n`ListWorkspaces` to get the next page of results. If this field is\nempty, it means there are no more results."}},"description":"Response message for listing workspaces."},"v1Workspace":{"type":"object","properties":{"name":{"type":"string","description":"The resource name of the workspace.\nFormat: organizations/{organization}/workspaces/{workspace}\nThis field is assigned by the server at creation and is immutable thereafter.\nClients may include this field in Get/Update/Delete requests to identify the resource."},"title":{"type":"string","description":"The user-defined display name for the workspace.\nThis corresponds to the `name` column in the database."},"workspace_icon":{"type":"string","description":"The workspace icon data.\nThis field contains the identifier of the workspace icon."},"workspace_icon_color":{"type":"string","description":"The color of the workspace icon."},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the workspace was created.","readOnly":true},"update_time":{"type":"string","format":"date-time","description":"The timestamp when the workspace was last updated.","readOnly":true},"creator_display_name":{"type":"string","description":"The display name of the user who created the workspace.","readOnly":true},"creator_email":{"type":"string","description":"The email address of the user who created the workspace.","readOnly":true}},"description":"A Workspace is a container for agents within an organization.","required":["title"]},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/organizations/{organization_id}/workspaces":{"get":{"summary":"List Workspaces","operationId":"ListWorkspaces","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ListWorkspacesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of workspaces to return.\nIf unspecified, at most 50 workspaces will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","description":"A page token, received from a previous `ListWorkspaces` call.\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListWorkspaces` must match\nthe call that provided the page token.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"Optional. A filter expression to constrain the workspaces returned.\nThe expression follows the syntax defined in AIP-160.\nSupported fields for filtering:\n  - `title`: The display name of the workspace\n\nExamples:\n  - `title = \"My Workspace\"` - exact match\n  - `title : \"workspace\"` - contains match (case-insensitive)","in":"query","required":false,"schema":{"type":"string"}},{"name":"order_by","description":"Optional comma-separated list of fields to order by, following AIP-132.\nSupported fields: title, create_time, update_time\nExample: \"title\", \"create_time desc\", \"update_time desc,title\"\nDefault ordering is by create_time descending if not specified.","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```

## GET /api/v1/me/organizations/{organization\_id}/workspaces

> Current User Organization Workspaces

```json
{"openapi":"3.0.0","info":{"title":"Kognitos API","version":"1.0.0"},"tags":[{"name":"Workspaces","description":"Manage workspaces, members, roles, invitations, and preferences."}],"servers":[{"url":"https://app.us-1.kognitos.com"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Personal Access Token."}},"schemas":{"v1CurrentUserOrganizationWorkspacesResponse":{"type":"object","properties":{"user_workspaces":{"type":"array","items":{"$ref":"#/components/schemas/v1Workspace"},"description":"The list of workspaces the current user has access to in the organization."},"next_page_token":{"type":"string","description":"A token to retrieve the next page of results.\nPass this value in the `page_token` field in the subsequent call to\n`CurrentUserOrganizationWorkspaces` to get the next page of results. If this field is\nempty, it means there are no more results."}},"description":"Response message for listing workspaces for the current user within a specific organization."},"v1Workspace":{"type":"object","properties":{"name":{"type":"string","description":"The resource name of the workspace.\nFormat: organizations/{organization}/workspaces/{workspace}\nThis field is assigned by the server at creation and is immutable thereafter.\nClients may include this field in Get/Update/Delete requests to identify the resource."},"title":{"type":"string","description":"The user-defined display name for the workspace.\nThis corresponds to the `name` column in the database."},"workspace_icon":{"type":"string","description":"The workspace icon data.\nThis field contains the identifier of the workspace icon."},"workspace_icon_color":{"type":"string","description":"The color of the workspace icon."},"create_time":{"type":"string","format":"date-time","description":"The timestamp when the workspace was created.","readOnly":true},"update_time":{"type":"string","format":"date-time","description":"The timestamp when the workspace was last updated.","readOnly":true},"creator_display_name":{"type":"string","description":"The display name of the user who created the workspace.","readOnly":true},"creator_email":{"type":"string","description":"The email address of the user who created the workspace.","readOnly":true}},"description":"A Workspace is a container for agents within an organization.","required":["title"]},"rpcStatus":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/protobufAny"}}}},"protobufAny":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}}},"paths":{"/api/v1/me/organizations/{organization_id}/workspaces":{"get":{"summary":"Current User Organization Workspaces","operationId":"CurrentUserOrganizationWorkspaces","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1CurrentUserOrganizationWorkspacesResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rpcStatus"}}}}},"parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page_size","description":"The maximum number of workspaces to return.\nIf unspecified, at most 50 workspaces will be returned.\nThe maximum value is 1000; values above 1000 will be coerced to 1000.","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page_token","description":"A page token, received from a previous `CurrentUserOrganizationWorkspaces` call.\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `CurrentUserOrganizationWorkspaces` must match\nthe call that provided the page token.","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","description":"Optional filter string following AIP-160 filtering standards.\nExample: \"title='Development'\"","in":"query","required":false,"schema":{"type":"string"}}],"tags":["Workspaces"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.kognitos.com/guides/api-reference/workspaces.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.