Using and managing workspaces

Use workspaces to organize your work in Postman and collaborate with teammates (or the world). Workspaces group together various elements such as collections, APIs, environments, mock servers, and monitors. A particular element can exist only in a single workspace. Access to elements in a workspace is controlled by workspace roles.

You can create new workspaces in addition to the default personal and team workspaces.

Contents

Accessing workspaces

To open a workspace, select Workspaces in the Postman header. Select a workspace to open it, or select View all workspaces to see a list of all available workspaces. You will only see workspaces that you have access to, based on the workspace visibility and your workspace role.

New Workspace

The workspace's Overview tab displays a summary and description of the workspace, as well as a list of recent activity. On the right, you'll also see the number of various elements within the workspace, such as collections and APIs, along with a list of recent contributors.

Workspace overview

Getting the workspace ID

To view the workspace ID, select the Workspace details icon. Copy the workspace ID to use it in collection requests or environments. You can also view the creator of the workspace and when was the workspace was last updated.

Workspace ID

Modifying a workspace

Workspace admins can edit workspace details or change the visibility of a workspace.

Editing workspace details

A summary and description help others understand what your workspace is for. You must be a workspace Admin to edit workplace details.

On the workspace's Overview tab, select the workspace name, summary, or description to edit it. You can add Markdown to the description—select Save when you're done.

Edit Workspace Summary & Description

Changing workspace visibility

The visibility setting for a workspace determines who can access it. You must be a workspace Admin to change the visibility for a workspace.

To change workspace visibility:

  1. Select Workspaces in the Postman header, and then select a workspace.
  2. On the workspace's Overview tab, select Workspace Settings.
  3. Select a Visibility for the workspace:
    • Personal: Only you can access.
    • Private: Only invited team members can access.
    • Team: All team members can access.
    • Public: Everyone can view.
  4. Select Update.
Changing workspace visibility

You always have one personal workspace in Postman. If you change the visibility of all of your personal workspaces to private, team, or public, Postman creates a new personal workspace for you.

Sharing workspaces

You can invite team members, groups, and external users to collaborate in a workspace by navigating to the workspace and selecting Invite in the upper-right corner.

Share team workspace

If you are a workspace editor or admin, you can invite anyone to personal, private, team, and public workspaces and assign them a workspace role. If you are a workspace viewer, you can invite external users to team and public workspaces, however you won't have the option to assign them a workspace role.

When you invite a collaborator to a personal workspace, it is automatically converted into a team workspace.

Individual team members and groups you invite will be notified immediately of your request to collaborate. External users who are not on your Postman team will receive an invitation to join immediately if you are a team admin. If you are not a team admin, your request to add external users to your Postman team will be shared with your team admins for approval.

You can also invite collaborators by selecting Changelog icon Copy Invite Link and sharing the link with them outside of Postman. When individuals select the link, they'll be prompted to log in or sign up. If you are a team admin inviting an external user, they'll be automatically added to your team. If you are not a team admin, a request to add them to your Postman team will be shared with your team admins for approval.

Managing workspace roles

Access to elements within a workspace is controlled using workspace roles. Roles can be assigned to an individual user or to a user group.

To change the role of people in a workspace, or to remove someone from a workspace:

  1. Select Workspaces in the Postman header, and then select a workspace.

  2. On the workspace's Overview tab, select Workspace Settings.

  3. Select a different workspace Role for a person or group:

    • Admin: Can manage workspace resources and settings.
    • Editor: Can create and edit workspace resources.
    • Viewer: Can view, fork, and export workspace resources.
    • Remove: Removes the person from the workspace. (You can invite the user again in the future.)
Changing workspace role

Watching a workspace

Watch a workspace to receive an email or in-app notification when a team member modifies anything in the workspace, such as changing the workspace visibility or updating an element in the workspace.

To start watching a workspace, select Watch on the upper right of the workspace's Overview tab. Select the count next to Watch to show how many people are watching the workspace.

Watching a workspace

To see notifications, select the bell Bell icon in the Postman header. The notification list shows details about changes to workspaces you are watching. You will also receive an email with information about the change, who made it, and when.

To stop watching a workspace, select Unwatch on the upper right of the workspace's Overview tab.

By default, you are a watcher for any workspace you create. You will not receive notifications for changes you make to a workspace you're watching.

Moving elements to workspaces

Workspaces can contain elements such as collections, APIs, environments, mock servers, and monitors. A particular element can exist only in a single workspace. If needed, you can move elements to a different workspace.

Monitors cannot be moved. If you move a collection that is being monitored, the associated monitor is paused and stays in the original workspace.

To move an element to a different workspace:

  1. Select Collections, APIs, Environments, or Mock Servers in the left sidebar.

  2. Select the three dots Three dots icon next to an element and then select Move.

    Move collection
  3. Select the workspace where you want to move the element, and then select the Move button.

    You cannot move elements from a private, team, or public workspace to a personal workspace.

    Move collection to workspace

Seeing who is in your workspace

See all of the people in your workspace and keep track of who's working on workspace elements at any given time. You can also make sure that all teammates who should be included in your workspace are there.

The avatars at the top of Postman window are bright when a user is active and dimmed when the user hasn't been active for fifteen to twenty seconds. Hover over the avatars to see the names of your teammates.

Active user

If more than three people are in a workspace, the fourth avatar will be a number representing the remaining users. Select the number to see a list of all active and inactive users. Any team member who has visited the workspace even once will be listed under the users list. You can collapse the list of active or inactive users.

Active user list

Deleting a workspace

Deleting a workspace removes the workspace and all data in it from Postman. Use caution, as once you delete a workspace it's gone forever. You must be a workspace Admin to delete a workspace.

My Workspace and Team Workspace are default workspaces created by Postman. You cannot delete these workspace, but you can rename them.

To delete a workspace:

  1. Select Workspaces in the Postman header, and then select a workspace.
  2. On the workspace's Overview tab, select Workspace Settings.
  3. Select Delete Workspace.
Delete workspace

To delete a public workspaces, you must first change the workspace visibility to team or private.

Next steps

View recent activity within a workspace to stay up to date with developments on your projects.

Last modified: 2022/01/21