Sharing your work

You can collaborate on Postman entities including collections, APIs, and environments, by sharing them via link or by moving them to a shared private, team, or public workspace.

To share a collection run, see Using the Collection Runner.

To share a collection via embed, use the Run in Postman button.

To share a collection as a file, see Importing and exporting data

Contents

To share your work via workspaces you will need to be signed in to your Postman account.

Sharing Postman entities

You can share your collections, APIs, and environments with collaborators by navigating to the entity you'd like to share in the left sidebar. Select it, then select Three dots icon > Share.

Collections, APIs, and environments can be shared directly with collaborators, including team members, groups, and external users.

Share api

If the entity resides in a private workspace and you are not a workspace admin, you will only be able to share it with team members who already have access to the workspace. If the entity resides in a personal workspace, you'll be prompted to either change the workspace visibility to team or create a new team workspace for the entity to reside in.

If you are an editor on the entity you are sharing, you'll have the option to give your new collaborators a Viewer or Editor role on the entity. If you are a viewer on the entity, you can share it, but you won't be able to assign roles.

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.

If your team has SSO enabled, external users will be required to sign in via your team's SSO.

Your team must have available slots or auto-flex enabled to invite additional team members.

You can also share collections via a Run in Postman button or via a JSON link.

Share collection via Run in Postman button

A JSON link is a shareable public link to a static snapshot of your collection. You can manage a complete list of your active collection links from your Postman profile.

Moving Postman entities to collaborative workspaces

You can move collections, APIs, and environments to shared workspaces to collaborate with your team.

You must be an editor on a collection, API, or environment, or the workspace admin, to move an entity to another workspace.

Navigate to the entity you'd like to share in the left sidebar, select it, then select Three dots icon > Move.

Use the search bar to find the workspace you'd like to move the entity to, or filter by workspace visibility by selecting the icon to the right of the search bar.

You can share entities to personal, private, team, and public workspaces that you have access to. Shared private, team, and public workspaces allow you to collaborate with others.

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

Refer to Roles and permissions for information on workspace access control within your team.

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

Move API

Note that items related to what's being moved will not move with the entity automatically:

  • Collections: Monitors will pause and stay in the current workspace.

  • APIs: Collections, documentation, monitors, mock servers, and environments of the API will stay in the current workspace.

  • Environments: Monitors, mock servers, and integrations using the environment may no longer work.

These items must be moved separately or re-configured in the new workspace.

Last modified: 2021/12/12