Collaborate with external partners in Postman using Partner Workspaces

Partner Workspaces are available on Postman Professional and Enterprise plans.

Partner Workspaces enable you to collaborate with external partners directly in Postman. You can use Partner Workspaces to help your partners consume your team's APIs and work together on API projects. With Partner Workspaces, you can build a single source of truth and integrate your partner projects into your Postman team, setting the foundation for an efficient and productive partnership.

As your partner programs grow, you need to create, maintain, and update separate workspaces with the same content for each partner. Instead, you could use Multi-partner mode. For more information, see Collaborate with multiple partners using multi-partner mode.

Creating a Partner Workspace

  1. Select Workspaces from the header, then select Create Workspace.

    Workspace menu
  2. You can use workspace templates to help you set up a new workspace. Select a workspace template to populate the workspace with helpful information and sample collections, or select Blank workspace to create an empty workspace. Then select Next.

    Create new workspace
  3. Define a workspace Name and Summary.

  4. Under Visibility, select Partner.

  5. Select Create.

    Create Partner Workspace

Anyone with permissions to create workspaces can request to create a Partner Workspace, but it must be approved by a Partner Manager. If you're not a Super Admin or Partner Manager, you must submit your request for approval. You can also add an optional note to your request. The workspace's visibility will be set to private until your request is approved. Postman will notify you when a Partner Manager reviews your request and approves or denies it.

To convert an existing workspace to a Partner Workspace, do the following:

  1. Open the workspace. In the Overview tab, select Settings.
  2. Under Visibility, select Partner.
  3. Select Update.

Anyone with permissions to change workspace visibility can request to convert a workspace into a Partner Workspace, but it must be approved by a Partner Manager. If you're not a Super Admin or Partner Manager, Postman will mention this and you can add an optional note to your request. Postman will notify you when a Partner Manager reviews your request and approves or denies it.

When a workspace is converted to a Partner Workspace, Postman sends in-app and email notifications to all workspace members.

Setting up a Partner Workspace

Before sharing a Partner Workspace with external collaborators, you can set your partnership up for success by moving or forking relevant elements into it.

You can also use workspace templates to help set up a new Partner Workspace. For more information, see Apply a template to a workspace.

Moving elements to a Partner Workspace

You must be an Editor on an API, collection, or environment, the Workspace Admin, Partner Manager, or a Super Admin to move an element to a Partner Workspace.

To move an element to a Partner Workspace, do the following:

  1. In the sidebar, select the element you want to move. Then select the more actions icon More actions icon > Move.

  2. Use the search bar to find the workspace you'd like to move the element to, or filter by workspace visibility by selecting the filter icon Filter icon.

    You can move elements to Partner Workspaces that you have access to.

  3. Select the workspace, then select Move (Collection, API, or Environment).

    Move element Partner Workspace

Items related to what you're moving, such as monitors and mock servers, won't move with the element automatically. For more information, see Moving elements to team workspaces.

If you'd like to keep certain elements in other workspaces, you can fork them into Partner Workspaces to help keep them up to date with any changes to the parent element.

Inviting collaborators to a Partner Workspace

Workspace Admins, Partner Managers, and Partner Leads can invite partners to Partner Workspaces. Your team can invite three partners assigned the Workspace Editor role at no extra cost. Partners must be external, third parties to your organization. When you assign a partner the Workspace Editor role, they can edit all workspace resources in the Partner Workspace, including collections. A paid seat is consumed when you assign partners the Workspace Editor or Collection Editor roles. Learn about adding paid seats.

The Partner Editor role is available on Postman Professional and Enterprise plans with the Partner Editor add-on.

Learn more about team and Partner Workspace roles.

To invite partners to a Partner Workspace, do the following:

  1. Open the workspace, select Settings in the workspace's Overview tab, and then select Invite.

    You can also select Invite in the Postman header.

  2. (Workspace Admins and Partner Managers only) Select Partners, then Continue.

  3. Enter the name, email, or group name of the partners.

  4. Set their workspace role.

    Your team must have available seats or Auto-Flex enabled to invite a partner as a Workspace Editor. Otherwise, the partner will be assigned the Workspace Viewer role, giving the partner permission to view all workspace resources. Assigning a partner the Workspace Viewer role doesn't consume paid seats.

  5. (Workspace Admins and Partner Managers only) Select Make them Partner Lead if you'd like them to also be able to manage and invite partners within the workspace.

  6. Select Invite Partners.

Partner invites must be accepted through the email address that was used to send the invite. If a partner wants to use a different email address, or if an invite was sent to the wrong email, you can revoke the invite and send a new one.

Partners will sign in to your team with a Postman username and password, even if your team is restricted to signing in with SSO.

Workspace Admins and Partner Managers can invite team members to Partner Workspaces.

To invite team members to a Partner Workspace, do the following:

  1. Open the workspace, select Settings in the workspace's Overview tab, and then select Invite.

    You can also select Invite in the Postman header.

  2. Select Team members, then Continue.

  3. Enter the name, email, or group name of the team members.

  4. Set their workspace role.

  5. Select Send Invites.

Viewing resources a partner can access

A Partner Manager can view the Partner Workspaces and collections a partner can access. A Partner Manager can also view the Workspace role partners are assigned in each workspace, and the Collection role partners are assigned in each collection. Open your team dashboard and select View resources next to a partner. Select a Partner Workspace or collection name to open it in a new tab.

View Partner Workspaces and roles

Collaborating in a Partner Workspace

The collaborative experience that Partner Workspaces offer depends on your role and status as a team member or external partner.

Collaborating as a team member

Partner Workspaces are only visible to invited team members, similar to private workspaces. 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.

Collaborating 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 personal or team 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.

Managing a Partner Workspace

Workspace Admins and Partner Managers manage workspace settings, users, and roles within a Partner Workspace. Partner Leads also manage users and roles of partners in Partner Workspaces.

Managing users and roles

You can assign team and Partner Workspace roles based on the functions team members and partners require. You can assign team roles for Partner Workspace roles at the team level, and you can assign Partner Workspace roles at the workspace level and collection level. Learn more about team and Partner Workspace roles.

To learn more about collaborating as a team member or partner, see Collaborating in a Partner Workspace.

Adding partner licenses

Your team has three partner licenses you can use to assign partners the Workspace Editor or Collection Editor roles. A paid seat is consumed when a partner is assigned at least one Editor role (at the workspace or collection level) in at least one Partner Workspace. Assigning a partner the Workspace Viewer or Collection Viewer role doesn't consume paid seats.

To assign more than three Workspace Editor or Collection Editor roles to partners, you must purchase additional partner licenses. To purchase more partner licenses, contact your Postman Account Manager or contact Postman's sales team.

Your team must have available seats or Auto-Flex enabled to invite a partner as a Workspace Editor. Otherwise, the partner will be assigned the Workspace Viewer role, giving the partner permission to view all workspace resources. Also, your team must have available seats to assign a partner as a Collection Editor.

Managing workspace elements

To move elements to a Partner Workspace, see Moving elements to a Partner Workspace.

To remove elements from a Partner Workspace, see Removing elements from a Partner Workspace.

Editing workspace details

Workspace Admins and Partner Managers can edit Partner Workspace 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.

Removing elements from a Partner Workspace

You must be at least an Editor on an API, collection, or environment to remove an element from a Partner Workspace. You can also be a Workspace Admin, Partner Manager, or Super Admin to remove any element from a Partner Workspace.

To remove an element by moving it to another workspace, do the following:

  1. In the sidebar, select the element you want to move, then select the more actions icon More actions icon > Move.

  2. Use the search bar to find the workspace you'd like to move the element to, or filter by workspace visibility by selecting the filter icon Filter icon.

    You can only move elements to workspaces that you have access to.

  3. Select the workspace, then Move (Collection, API, or Environment).

It's not recommended, but you can choose to delete an element entirely. To do so, select the element in the sidebar, then select the more actions icon More actions icon > Delete.

Deleted APIs and environments aren't recoverable. You can recover collections smaller than 30 MB for up to 90 days on an Enterprise plan. To do so, select Delete icon Trash from the Postman footer.

Removing partners from a Partner Workspace

You can remove partners from individual Partner Workspaces. To remove a partner from a Partner Workspace, see Managing workspace roles.

You can remove partners from a team. Removing a partner from a team removes them from all Partner Workspaces. If you remove the last Admin from the team, users assigned the Partner Manager role will be assigned the Admin role. Also, if you remove a partner from their last Partner Workspace, they'll be removed from the team. To remove a partner from a team, see Remove team members.

Deleting a Partner Workspace

Workspace Admins and Partner Managers can delete Partner Workspaces.

  1. On the workspace's Overview tab, select Settings.
  2. Change the visibility of the workspace to Private.
  3. Select Remove all partners, then select Update.
  4. Select Delete Workspace.

Postman notifies all workspace members in-app and by email when you delete a Partner Workspace.

Last modified: 2023/03/02