> For the complete documentation index, see [llms.txt](https://docs.atomyx.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.atomyx.io/atomyx-vault/workspaces.md).
# Workspaces
## Overview
The Workspaces overview page is accessible from the user-level sidebar navigation. It displays all workspaces that the current user is a member of, presented as a card grid.
### Workspace Cards
Each workspace card displays the following information:
* Workspace logo- the uploaded workspace logo, or a default placeholder if no logo has been set
* Workspace name - the display name of the workspace
* Role badge - the current user’s role in that workspace (Owner, Admin, Member, or Billing)
Clicking a workspace card navigates to that workspace’s dashboard, and the sidebar switches to the workspace-level navigation (Settings, Products, Users, Groups).
### Creating a Workspace
The “+ Add Workspace” button on the Workspaces overview page initiates the workspace creation process. Creating a new workspace requires providing:
* Workspace name - a descriptive name for the organization or team
* Unique shortname - a URL-friendly identifier used in workspace URLs
The user who creates a workspace is automatically assigned the Owner role in that workspace. After creation, the workspace appears in the creator’s workspace list and can be configured further through the Settings page.
{% hint style="info" %}
***Note:** The workspace shortname must be unique across all Atomyx Vault workspaces and is used in URLs to identify the workspace. Choose a meaningful, concise shortname that represents the organization. Once set, changing the shortname may affect existing URLs and integrations.*
{% endhint %}
### Switching Between Workspaces
Users who are members of multiple workspaces can switch between them in two ways:
* Workspaces overview page - navigate to the user-level Workspaces page and click a workspace card
* User dropdown menu - click the user name at the bottom-left of the sidebar to open the dropdown, which displays a list of available workspaces for quick switching
## Workspace Settings
The Settings page is accessible from the workspace-level sidebar navigation. It provides two main configuration sections: Admin Contacts and General Settings.
### Admin Contacts
The Admin Contacts section displays a table of workspace members who hold administrative roles. The table includes the following columns:
Type
Description
Member
The name of the workspace member
Owner
Indicates whether the user has the Owner role (checkbox)
Admin
Indicates whether the user has the Admin role (checkbox)
Billing
Indicates whether the user has the Billing role (checkbox)
This table provides a quick overview of the administrative structure of the workspace. The contact information shown here corresponds to the roles assigned on the Users page.
{% hint style="info" %}
***Note:** The Admin Contacts table is a read-only summary view. To change user roles, navigate to the Users page and use the “Change role” action from the context menu.*
{% endhint %}
### General Settings
The General Settings section provides configuration options for the workspace’s identity and branding.
#### Workspace Logo
The workspace logo is displayed on workspace cards in the Workspaces overview, in the sidebar when viewing the workspace, and in the user dropdown menu for quick identification.
Logo requirements:
* Supported formats: JPG, JPEG, PNG
* Maximum file size: 10 MB
* Recommended: a square image that is clearly recognizable at small sizes
Administrators can upload a new logo or replace the existing one by clicking the logo area in the General Settings section.
#### Workspace Name
The workspace name is the display name shown throughout the Atomyx Vault interface. It should represent the organization, company, or team that the workspace belongs to. The name can be changed at any time by a workspace administrator.
#### Unique Shortname
The unique shortname is a URL-friendly identifier for the workspace. It is used in workspace URLs and as a compact reference. The shortname must be unique across all Atomyx Vault workspaces.
{% hint style="info" %}
***Note:** Changing the workspace shortname will affect any URLs or bookmarks that reference the workspace by its shortname. Coordinate shortname changes with users who may have saved workspace links.*
{% endhint %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## 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.atomyx.io/atomyx-vault/workspaces.md?ask=
```
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.