RESTKDocs

Workspaces

Organize your API collections, folders, and requests in personal and team workspaces.

5 min read

Workspaces help you organize your API projects. You can create personal workspaces for individual work or organization workspaces for team collaboration.

Quick Start

Create a Workspace

Click + Add Workspace to create a new workspace

Name Your Workspace

Enter a unique name like "Development APIs" or "Production Testing"

Start Building

Add collections, folders, and requests to your workspace

Offline Support

You can view and browse workspaces offline. Creating, editing, and deleting workspaces requires an internet connection.

Creating a Workspace

Personal Workspaces

Navigate to Workspaces

View your workspace list in the sidebar

Add Workspace

Click the + button or Add Workspace

Enter Details

Provide a workspace name and click Create

Internet Required

Creating workspaces requires an internet connection.

Organization Workspaces

Organization workspaces allow your team to collaborate on API projects.

Switch to Organization

Select your organization from the context switcher

Create Workspace

Click + Add Workspace (Owner or Admin org role required)

Configure

Enter the workspace name and save

Who can create organization workspaces:

  • Owner and Admin can create, edit, and delete workspaces
  • Members can view and work within workspaces they have access to

Two Role Systems

Organization roles (Owner/Admin/Member) control who can create and manage workspaces. Workspace roles (Owner/Manager/Editor/Viewer) control what you can do inside a workspace. See Roles & Permissions for details.

Editing a Workspace

Open Workspace Menu

Right-click on a workspace in the list

Select Edit

Choose Edit from the context menu

Update Name

Change the workspace name and save

Internet Required

Editing workspaces requires an internet connection.

Deleting a Workspace

Right-Click Workspace

Open the context menu for the workspace

Select Delete

Choose Delete from the menu

Confirm Deletion

Confirm to permanently delete the workspace and all its contents

Permanent Action

Deleting a workspace removes all collections, folders, and requests inside it. This action cannot be undone.

Switching Between Workspaces

Click any workspace in the sidebar to switch to it. Your currently selected workspace displays its collections, folders, and requests in the main view.

Features:

  • Switch instantly between workspaces
  • Each workspace maintains its own content
  • Your last selected workspace is remembered when you restart

Switching Contexts

Personal to Organization

Open Context Switcher

Click the context switcher at the top of the sidebar

Select Organization

Choose your organization from the list

View Workspaces

Organization workspaces load with appropriate permissions

Organization to Personal

Open Context Switcher

Click the context switcher

Select Personal

Choose Personal to return to your individual workspaces

Context Memory

The app remembers your last context and workspace selection when you restart.

Offline Behavior

When offline, you can:

  • View and browse all cached workspaces
  • Switch between workspaces
  • Work with cached collections and requests

When offline, you cannot:

  • Create, edit, or delete workspaces (requires internet)

Auto-Sync

When you reconnect, the app automatically refreshes your workspace data.

Workspace State

Empty Workspace

If you have no workspaces, you'll see an empty state with a prompt to create your first workspace.

Create First Workspace

Click Create Your First Workspace (requires internet)

Name It

Choose a name for your initial workspace

Start Building

Begin adding collections and requests

Active Workspace Deleted

If the workspace you're viewing gets deleted (by you or another team member), the app automatically switches to another available workspace or shows the empty state.

Permissions

Personal Workspaces

ActionAvailableRequires Internet
CreateYesYes
EditYesYes
DeleteYesYes
ViewYesNo

Organization Workspace Management

Organization roles control who can create, edit, and delete workspaces:

Org RoleCreate WorkspaceEdit WorkspaceDelete WorkspaceView Workspaces
OwnerYesYesYesYes
AdminYesYesYesYes
MemberNoNoNoYes

All create, edit, and delete operations require an internet connection.

Workspace Content Permissions

Once inside a workspace, workspace roles control what you can do with collections, folders, and requests:

Workspace RoleViewCreate & EditDeleteManage Members
OwnerYesYesYesYes
ManagerYesYesYesYes
EditorYesYesNoNo
ViewerYesNoNoNo

Workspace Roles vs Organization Roles

Organization roles (Owner/Admin/Member) control workspace management. Workspace roles (Owner/Manager/Editor/Viewer) control content permissions within a workspace. See Roles & Permissions for the full breakdown.

Best Practices

  1. Use Descriptive Names - Name workspaces clearly like "Mobile App APIs" or "E-commerce Backend"
  2. Organize by Project - Create separate workspaces for different projects or environments
  3. Team Workspaces for Collaboration - Use organization workspaces when working with your team
  4. Personal for Experiments - Use personal workspaces for testing and experimentation

Next Steps