A public workspace can enhance a new user’s onboarding experience with your API, inspire your existing users with new use cases and resources, increase your API’s discovery in Postman search results, and enable you to work publicly with partners. Anyone in the Postman community can access a public workspace.
Before other Postman users can work with your team in a public workspace, your team needs to have a public team profile. A public team profile encourages other users to collaborate with you in a public workspace, enables you to ask for contributions and gather feedback, and increases your API’s discovery in search results. A public team profile also shows up on the Postman API Network.
Admins manage the team profile and other team settings.
To make your team profile public, do the following:
For information on how to create a public profile, see Edit your publisher team.
You can create a public workspace to share your workspace and its elements with the Postman community on the Postman API Network.
Make sure to never expose secrets, such as API keys, in your public workspaces. The Postman Secret Scanner scans your public workspaces to detect any exposed secrets.
To create a public workspace, do the following:
As a Workspace Admin, you can convert an existing workspace to a public workspace. If you’re on a Postman Team or Enterprise plan, making a workspace public requires a Community Manager’s approval. Once you make a workspace public, all elements within that workspace become publicly available on the Postman API Network.
Before you convert your workspace to a public workspace, make sure you aren’t exposing any secrets. You can give your API consumers a placeholder variable or vault secret (recommended). Learn how the Secret Scanner scans your public workspaces.
Postman sends in-app and email notifications to all workspace members when the workspace is made public. To view your in-app notifications, click the notification icon in the Postman header.
To convert a workspace to a public workspace, do the following:
If you’re submitting a request to make a workspace public, the Secret Scanner scans the workspace for any exposed secrets. The workspace’s visibility is set to internal until it’s approved. While you’re waiting for the request to be reviewed, you can check the status of the secret scan or cancel the request from the workspace settings.
You can feature collections in a public workspace to give API consumers quick access to specific collections. On a public workspace’s Docs tab under Featured collections, click Add, then select the collection you’d like to feature.
You can choose an environment for each featured collection you’d like to be active when it’s opened. The environment will be active in the environment selector.
To remove a featured collection, hover over the collection and click .
An informative and inviting public workspace can help increase adoption of your APIs. To invite collaboration from other users on your public workspace, you need to have:
Signs of a public workspace that invites collaboration include:
For more information on using a public workspace to help increase adoption of your API, see Increasing adoption of an API with a public workspace on the Postman blog.
You can share a public workspace by giving collaborators its workspace URL directly.
To access a workspace’s URL, do the following:
When you share a workspace with Postman users who aren’t team members, its visibility must be public. If the workspace is an internal workspace, users who don’t have access won’t be able to open it.
Keep the watchers of your workspace and collection informed about any changes to your APIs. You can share updates across multiple collections and link to the specific request, collection, or folder that changed. These watchers get notified and can engage with these updates by commenting and reacting.
You can post updates to keep your workspace watchers informed about changes to your APIs. Postman teams can connect up to 10 Slack channels to a single public workspace. Your API consumers can respond to a workspace update by adding a comment or reacting with an emoji response.
To post a workspace update, do the following:
If a Slack channel is already subscribed to workspace updates, the checkbox next to Share on Slack on the bottom right of the post is checked. If not, click Connect in the workspace overview to subscribe to a channel. Ensure the box is checked to send notifications when someone posts a workspace update. To learn more, visit the Slack integrations page.
To share a workspace update, do the following:
Click .
You can choose from the following sharing options:
Viewers in a public workspace (including those inside and outside the team that owns the public workspace) can subscribe to public workspace updates.
To edit or delete an update, do the following:
When a user opens a public workspace, Postman shows an overview of its contents, activity, and members. The user interacts with the contents of the public workspace, including the collections, environments, and other elements. As a team member with an Admin role on the workspace, you can manage the overview, the elements in the workspace, and the members of the workspace.
Users with an Admin role for a workspace can edit workspace details, including updating the workspace’s name, summary, description, and visibility. For more information, see Editing workspace details.
The Postman API Network displays your workspace’s name and summary. Make your workspace name and summary informative to improve its visibility on the Postman API Network.
You can move Postman elements from your internal workspace into a public workspace. Elements include collections, environments, mock servers, flows, and specifications. You must have an Admin or Editor role for the public workspace to move elements to it.
You can’t move elements from a public workspace to an internal workspace.
To move an existing element to a public workspace, do the following:
The Postman element that you move to the public workspace will no longer exist in the original workspace.
If there are monitors, mock servers, or integrations associated with the moved element, they remain in the original workspace.
You can delete Postman elements from a public workspace for which you have an Admin or Editor role.
Learn more about deleting a collection and restoring a deleted collection.
To delete a public workspace, you must change its visibility first. You must have an Admin role for a workspace to be able to delete it.
If you’re an Admin, you can manage collaborators and user roles in a public workspace:
Team members will receive an email and in-app notification when they’re added to a public workspace.
To collaborate with someone else in their public workspace, select Workspaces from the header, and then select the workspace you want to work in.
For collections and environments, create a fork and request to merge changes using a pull request.
For APIs, select the API and version. Select the Definition tab and then select Request Access to request an Editor role.
You can access public workspaces using the Postman Explore page’s Workspaces category. You can also access the public workspaces that you own or are a member of using Workspaces in the header.
The list of avatars in the Postman header shows you who’s active in your workspace. This list will include all active users with public profiles, and users who’ve chosen to remain anonymous by not enabling their public profile.
Viewers in a public workspace (including those inside and outside the team that owns the public workspace) can subscribe to public workspace updates.
Once you start working collaboratively in a public workspace, users can fork collections and create pull requests.