Share your work in Postman

Postman enables you to collaboratively iterate on your APIs with developers, testers, architects, and other business stakeholders using private, public, and internal methods. You can share your work in Postman by sharing your workspace. You can also share individual Postman elements including collections, requests, and examples.

Share your Postman workspace

You can share a workspace by using the Invite option or by copying a link to your workspace. For more information, visit Sharing workspaces.

To share your work with external partners, use a Partner Workspace. If you want to share your work with developers globally, use a public workspace.

Share Postman collections and other elements

You can share your collections, requests, examples, collection folders, APIs, Flows, and environments with your team members and allow guest users who are part of your organization to view your collections.

Other Postman elements are shared differently:

You can share Postman elements with your team by selecting specific team members or by using the Run in Postman button, the Postman API, or by sharing a link.

Share Postman elements with specific team members

To share Postman elements by selecting team members, do the following:

  1. From the element's more actions dropdown list More actions icon select Share.

  2. Select the With people tab.

  3. Enter the name, email address, or group name.

  4. If you have an Editor role for the element you are sharing, you can specify a Viewer or Editor role.

  5. If you're sharing a collection, collection folder, request, or example, you can also specify an active environment from the Select an Environment dropdown list.

    To change the active environment for the team members and groups you want to share with, you must reshare the collection, collection folder, request, or example with them. Choose a new environment in the Select an Environment dropdown list, then select Share.

  6. Select Share.

    Share a collection using name, email, or group

Postman emails the selected people that you shared the element with them.

If the element you want to share is in a personal workspace, you'll be prompted to change the workspace visibility to Team or create a new team workspace for the element. For more information, visit Collaborating in team workspaces.

If the element you want to share is in a private workspace, users who don't have access to the private workspace will be invited as workspace Viewers when the element is shared with them.

Share using a Run in Postman button

You can share collections in a public page such as a website or README by embedding a Run in Postman button.

  1. From the element you want to share, select Share.
  2. Select Via Run in Postman.

For more information on making and using a Run in Postman button, visit Create a Run in Postman button.

Share a collection with a Run in Postman button

Share using the Postman API

To share the collection JSON using the Postman API, do the following:

  1. From the collection that you want to share, select Share.

  2. Select Via API.

  3. Select Get collection JSON using Collection Access Key.

  4. Select Generate New Key to create a read-only collection access key. This key expires after 60 days of inactivity.

    Make sure you remove any sensitive information from your collection before sharing collection access keys.

  5. (Optional) Select Manage keys to view or revoke this collection access key on your API keys page. To learn more about collection access keys, visit Generate a collection access key.

Anyone with this link has read-only access to the collection's JSON. The data that this Postman API endpoint serves reflects the current state of the collection.

Share a collection via API

If you want to share a link with other users, select Link to collection in public workspace to provide a link to the collection. Anyone with this link can view and fork your collection.

Share a collection with a link to a public workspace

Share using a URL

Hover over the element's name in the overview page and select the link icon Link icon to copy the element's URL to the clipboard.

For requests, you can also select the more actions dropdown list More actions icon next to the element you want to share and select Copy link to copy the element's URL to the clipboard.

To share a URL to a collection, collection folder, request, or example with an active environment selected, choose an environment using the environment selector, copy the element's link to your clipboard, then send the link to team members you want to share with.

You can also use the Postman VS Code extension to share a collection and environment, or a URL to a collection and environment.

Share collections with guest users in your organization

Collection Editors can allow guest users who aren't in your Postman team but are part of your larger organization to view a specific collection and send requests in that collection. You must have the Editor role in the collection you want to share with guest users.

The collection must be in a team workspace. If the collection is in a personal or private workspace, you can't share the collection with guest users. For more information, see Collaborating in team workspaces.

If you're on an Enterprise team, Team Admins and Super Admins can allow or prohibit Collection Editors from sharing collections with guest users in team workspaces.

Once you allow guest users to view a specific collection, send them the collection URL to sign in to Postman and view the collection. Guest users who sign in to Postman using the collection URL are assigned the Guest role at the team level and a limited Viewer role at the collection level.

Assigning a guest user the Guest role doesn't consume paid seats.

To allow a guest user to view a collection, do the following:

  1. From the collection you want to share, select Share icon Share.

  2. Select With people.

  3. Turn on the toggle next to Allow Guests to join your team and view this collection with the link.

  4. Select Copy Link to copy the collection URL.

    Copy collection URL
  5. Send the collection URL to guest users who you want to view the collection. Postman requires guest users to sign in to Postman before they can view the collection.

Rules of sharing with guest users

Anyone who has access to the collection URL can view the collection if the toggle next to Allow Guests to join your team and view this collection with the link is turned on. Your team must have available seats or Auto-Flex enabled to invite more team members. If your team has SSO enabled, users who aren't part of your team will be required to sign in using your team's SSO.

The following permissions by role apply when sharing a collection with guest users:

RolePermissions
Team Admin or Super AdminUsers who aren't on your Postman team will receive an invitation to join your team.
Developer role on your team on a Free, Basic, or Professional planUsers you share an element with are added to your team as Developers automatically, without the need for approval by a Team Admin.
Not a Developer on a Free, Basic or Professional plan or a Team Admin on any planA Team Admin must approve your request to share an element with a user who isn't part of the team.

Change guest user access to collections

You can change a guest user's role at the team and collection levels. You can also revoke access to viewing collections for new and existing guest users.

To learn how to change a guest user's team role, see Manage guests. To learn how a guest user can request a role change, see Requesting Editor role access for a collection as a guest user.

You can turn off the toggle next to Allow Guests to join your team and view this collection with the link. When you turn this off, new guest users can no longer be assigned the Guest role. Guest users already assigned the Guest role will continue to have access to the collection.

To remove guest users at the team level, see Remove team members. In certain cases, Guests with access to only one collection are automatically removed from the team:

  • If the Workspace Admin removes them from the collection

  • If the Workspace Admin removes the guest from the workspace the collection is in

  • If the Workspace Admin changes the visibility of the workspace the collection is in to private

  • If the Workspace Admin deletes the workspace the collection is in

To remove guest users at the collection level, do the following:

  1. Select the more actions icon More actions icon next to the collection name and select Manage roles.

  2. Select Remove for the users you want to revoke access to the collection.

  3. Select Update Roles.

    Remove external user at collection level

Removing guest users from collections doesn't revoke their access to the workspace the collection is in. To revoke their entire access to the team, see Remove team members.

Last modified: 2023/06/15