Collaborate in a Partner Workspace

Partner Workspaces are available with Postman Professional and Enterprise plans.

The collaborative experience that Partner Workspaces offer depends on your role and status as a team member or external partner. Learn how to collaborate, keep your partners informed about the API changes, and fork Partner Workspace collections as a Partner Viewer.

Collaborate as a team member

Partner Workspaces are only visible to invited team members. Once invited, you can access Partner Workspaces as you would access any other workspace. To open one, select Workspaces in the Postman header, then select the Partner Workspace.

Users can be assigned the team-level Partner Manager role. Partner Managers can view all Partner Workspaces within an organization, and can control their settings, visibility, and partner invites. To learn more, see Partner team and Partner Workspace roles.

Collaborate as a partner

When an external partner is invited to a Partner Workspace by a team they're working with, they only have access to that Partner Workspace and can't access any other workspaces or resources within the team. Partners don't have internal workspaces within the team they're partnering with.

At the team level, all external partners are automatically assigned the Partner role. At the workspace level, all partners are assigned the Workspace Editor or Viewer roles. If partners are assigned the Workspace Editor role, they can edit all workspace resources in the Partner Workspace, including collections. If partners are assigned the Workspace Viewer role, they can be assigned the Collection Editor role for specific collections. Partners can also be assigned the Partner Lead role, which enables them to invite other individuals from their organization to the Partner Workspace.

To learn more about partner roles and permissions, see Partner team and Partner Workspace roles.

Keep your partners informed about API changes

API publishers can use workspace updates to communicate API changes. Suppose you set up a single Partner Workspace to work with your highly valued API consumer. When you save a change, for example, to a request, you're prompted to post a workspace update. Select Post an update and the Updates tab opens.

You can access workspace updates at any time by selecting the Updates tab on the workspace overview page. Select the workspace name on the top left, and select the Updates tab. To create an update, follow the instructions in Communicate API changes using workspace updates.

When your partner accesses your workspace, a notification badge appears on the Updates tab, signaling that there are new updates since the last visit. Your partner can then respond with comments, questions, and other types of feedback.

Slack and Team integrations aren't available for Partner Workspaces.

In multi-partner mode, API publishers can use workspace updates to broadcast API changes to multiple partners.

Commenting and replying to workspace updates is turned off in multi-partner workspaces to keep collaboration private.

Fork and create your own collection

When you set up a Partner Workspace and collaborate with partners, your partners can create a fork and take a copy to their own team. This helps partners edit the collection privately and also collaborate with their colleagues in the partner organization. Your partners can then construct their own real-world API workflows using the forked collection.

Any partner - whether they're a Viewer and Editor - can create cross-team forks as long as they're on a paid Postman plan (Basic, Professional or Enterprise). If your partner isn't on a paid plan, and you want to provide them the ability to fork, you can assign them the Editor role in the Partner Workspace. Partner Editors can fork to any team that they're part of. Learn more about roles.

Fork a Partner Workspace collection as a Partner Viewer

Workspace Admins can invite Partners as Viewers to the Partner Workspace. When you're logged in as a Partner, you can see a diamond symbol over your avatar. In this sample team, you're a Partner Viewer, which means you have a Viewer role in all the team's Partner workspaces.

To fork a collection, do the following:

1. On the collection, select the more actions icon and select Create a fork.

2. Specify your own Fork label.

   

3. Select the Fork Destination.

   • The Team dropdown displays a list of teams that you are part of. The first listed item is the current team where you are a partner. Also listed are other teams that you are part of. In this example, one of the teams is on a Basic (paid) plan and the other one is on a Free plan. In this scenario, you would select the Basic Team because it's a paid team on a basic plan. Select Continue.
   • The Workspace dropdown shows a list of workspaces within the selected team where you have Editor permissions. Select a workspace and then Fork Collection.

   Cross-team forking is enabled only if the partner is part of a paid team. To fork to a team that's on a Free plan, you need to upgrade the team to a paid team.

Creating a cross-team fork switches your team and takes you to the workspace where the fork is created. You can see that a fork is created in a different team. Cross-team forks can be created in any workspace within a paid team.

If you select the fork icon next to the collection name, you can see which collection and team the fork is created from.

If you select the collection link, you are prompted with an option to switch teams because the source collection for this fork is in a different team.

Selecting Switch Team redirects you the Partner Workspace that has the source collection.

Fork a Partner Workspace collection as a Partner Editor

Partner Editor is a Partner who has Editor permissions on one or more Partner workspaces. To fork a collection as a Partner Editor, you can follow the same steps as a Partner Viewer. However, as a Partner Editor you can fork to a workspace in any team that you are part of.

As a Partner Editor forking a collection from a Partner Workspace, you have these options:

• Fork within the same team - Select the current team in the Team dropdown, then select a workspace where you have Editor permissions.

• Fork to a different team - Select the Team dropdown. The workspaces where you have Editor permissions are shown. Select a team and then Fork Collection.