Using Workspaces
Workspaces is an easy and efficient way to collaborate with a group of users to develop and test APIs. You can either organize your work in personal Workspaces or work with others in team Workspaces. Postman designed a set of features that unleashes the power and versatiltity of using Workspaces.
Here you’ll learn how to perform actions on Workspaces and how to use Workspaces to work with Postman elements.
Performing actions in Workspaces
Using Workspaces with Postman elements
Adding collections and environments from another Workspace
You can add collections or environments from one Workspace to another personal or team Workspace.
In the Workplaces dashboard, select a Workspace and click the Add to workspace button. The personal Workspaces view appears by default. Click “Team” to add collections or environments to team Workspaces.
In the Add to this Workspace page, select the source Workspace that contains the collection or environment you want to add to the target Workspace. Then click “Collection” or “Environment” and select the element(s) you want.
Click the Add to this Workspace button. The element(s) appear in your list of collections or environments in the target Workspace.
Removing elements from Workspaces
When you remove a Workspace, it is no longer visible in that particular Workspace. The element is still available in any other Workspace where it exists.
You can remove an element from a Workspace in the Postman app sidebar, or in the Workspaces dashboard.
Removing collections from a Workspace in the sidebar
In the Postman app, select a collection and click the Ellipsis (…) button.
Click “Remove from Workspace”. The collection is no longer visible in the Workspace.
Removing elements from a Workspace in the dashboard
In the Workspaces dashboard, click an element. In this example, we click “Collections”.
Click the Ellipsis (…) button in the element you want to remove and select “Remove from workspace”. The Workspace is no longer visible in the Workspace.
Deleting Workspaces
When you delete an element, you erase its existence in Postman.
To delete a Workspace, go to the Workspaces dashboard and select a Workspace. In this example, we select a team Workspace to delete.
Click the Ellipsis (…) button for the element you want to delete and select “Delete”.
In “Delete Workspace”, click the Delete button. Remember when you delete a Workspace, it is gone forever!
Joining Workspaces
A user can join a Workspace to work on collections, environments, monitors, mocks, and integrations. Let’s see how.
In the Postman app, click a Workspace in the header bar, which is “Neutrino level dectection” in this example.
Select “Team” and select a Workspace to join under WORKSPACES YOU CAN JOIN.
In the Collections view, click the Join button.
In the confirmation message, click the Start Building button to complete the process.
Sharing Workspaces
Postman lets you share your personal Workspaces with other users.
In the Workspaces dashboard, select a personal Workspace you want to share. Next, click the Ellipsis (…) button and select “Share”.
In “Share a personal workspace”, select the users with whom you want to share the Workspace from the “Members” dropdown menu.
Click the Share this workplace button. Your shared Workspace appears in team Workspaces.
Sharing collections in Workspaces
Postman enables you to share your collections in Workspaces from the Postman app and the Workspaces dashboard.
Sharing collections in the sidebar
In the Postman app, select a collection in the sidebar and click the Ellipsis (…) button.
Select “Share Collection”. The SHARE COLLECTION modal appears. It offers three ways to share a collection: “Share in another workspace”, “Embed”, and “Get Link”.
Sharing collections in another Workspace
Select this option to add a collection to a team Workspace. The collection is visible to the team.
Sharing collections with the Embed or Run In Postman button
Select this option to embed a Run in Postman button in your collection for your API documentation, website, or Github readme.
The Run in Postman button lets anyone import and run this collection with one click. When you click the Generate Code button, you get a link that you can use for a dynamic or static button. You can also select the environment you want for the generated code.
The Run in Postman button shares the collection directly from Postman, so the collection is uploaded to Postman servers when you generate the embed code
Sharing collections with a link
Select this option to generate a shareable link for others to access your collections. You can manage a complete list of your collection links from your Workspaces dashboard.
Viewing details in Workspaces
You can view the details of your personal or team Workspaces.
In the Workspaces dashboard, select a personal or team Workspace.
Viewing details for personal Workspaces
To view the details of your personal Workspaces, select “View Details” from the Ellipsis (…) button menu.
Viewing details for team Workspaces
To view the details of your team Workspaces, select “View Details” from the Ellipsis (…) button menu.
Renaming Workspaces
You can rename your personal or team Workspaces.
In the Workspaces dashboard, select a personal or team Workspace and click the Ellipsis (…) button.
Renaming personal Workspaces
To rename your personal Workspaces, select “Rename” from the Ellipsis (…) button menu. Then enter the new name for the Workspace in the “Name” field and save your changes.
Renaming team Workspaces
To rename your team Workspaces, select “Rename” from the Ellipsis (…) button menu. Then enter the new name for the Workspace in the “Name” field and save your changes. You must have admin privileges to modify team settings.
Sharing elements to Workspaces
You can share Postman elements (collections, environments, monitors, mocks, and integrations ) with other Workspaces. In this example, we share a collection to a Workspace.
In the Collections view, select the collection you want to share, and click the Share button.
In “Share this collection”, select the Workspace of which you want to share this collection, and click the Share button.
Publishing Workspaces
Postman enables you to publish your collection and make it availabe to anyone with the published link.
To publish a Workspace collection, go to the Workspaces dashboard and click a personal or team Workspace.
In the Collections view, click the Ellipsis (…) button and select “Publish”.
In “Publish Collection”, select the:
-
Environment
The collection’s public documentation contains the shared environment.
-
Custom domain
The selected domain contains the published domain.
-
Custom styling options
You can determine the color of the top bar, right side bar, and the highlight.
Click the Publish Collection button. Postman generates API documentation for your collections automatically in real-time.
Leaving Workspaces
Postman allows you to leave a team Workspace. To leave a team Workspace, select a team Workspace, click the Ellipsis (…) button, and select “Leave”.
In “Delete Workspace”, click the Leave workspace button. You can no longer work or add collections and environments to the Workspace.
Editing descriptions in Workspaces
You can edit descriptions for personal and team Workspaces. In this example, we use a personal Workspace.
In the Workspaces dashboard, select a Workspace, click the Ellipsis (…) button, and select “Edit Description”.
In “Edit workspace details”, enter a new description in the “Summary” text box and save your changes.
Managing members of team Workspaces
When you need to manage the members of your team Workspace, go the Workspaces dashboard and select the “Team” view.
Click the Ellipsis (…) button and select “Manage Members”.
In “Edit workspace details”, add or delete team members in the “Members” dropdown menu and save your changes.