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.

You can share a workspace using the Invite option or copying a link to your workspace. For more information, view Share 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.

You can share your collections, APIs, Flows, and environments with and outside your team and enable guest users who are part of your organization to view your collections.

Other Postman elements are shared differently:

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

To share a collection as a file, view Importing and exporting data.

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

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

Select View more actions next to the element you want to share, then select Share.
If you're sharing a collection, select the With people tab.
Enter the name, email address, or group name.
If you have an Editor role for the element you are sharing, you can specify the Viewer or Editor role.
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.
Select Share.

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

If the element 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 Change workspace visibility.

If the element is in a private workspace, users without access to the private workspace will be invited as workspace Viewers when the element is shared with them.

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

From the element you want to share, select Share.
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

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

From the collection that you want to share, select Share.
Select Via API.
Select Get collection JSON using Collection Access Key.
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.
(Optional) If you have permission to manage public elements, you can select Manage keys to view or revoke this collection access key on the Manage public elements page. You can also view or revoke collection access keys you created 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.

If you want to share a link with other users, select Link to collection in public workspace to provide a link to the collection. The collection must be in a public workspace. If the collection isn't in a public workspace, select Move Collection, then choose a public workspace to move it to. Select Copy link to copy the link to your clipboard, then share the link with others. Anyone with this link can view and fork your public collection.

Share a collection with a link to a public workspace

You can share collections and other elements with your team and coworkers who aren't part of your team.

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

For requests, you can also select View more actions > Copy link to copy the request's URL to your clipboard. Then, select Copy link to copy the element's URL to your clipboard.

You can share a URL to a 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.

If the person you're sharing a link with isn't part of your team, they'll be prompted to request to join the team.

A Team Admin will then approve or deny the request.

Approve or deny the request to join the team

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.

Collection Editors can enable guest users who aren't in your Postman team but are part of your larger organization to view a collection and send requests. 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.

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

Once you enable 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 user the Guest role doesn't consume paid seats.

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

From the collection you want to share, select Share.
Select With people.
Enable Allow Guests to join your team and view this collection with the link.
Select Copy Link to copy the collection URL.
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.

Anyone with access to the collection URL can view it if Allow Guests to join your team and view this collection with the link is enabled.

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:

Role	Permissions
Team Admin or Super Admin	Users who aren't on your Postman team will receive an invitation to join your team.
Developer on your team on a Free, Basic, or Professional plan	Users 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 plan	A 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, view Manage guests. To learn how a guest user can request a role change, visit Request Editor role access for a collection as a guest user.

You can turn off Allow Guests to join your team and view this collection with the link. When you turn this off, new guest users can't 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, view 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:

Select View more actions next to the collection name and select Manage roles.
Select Remove for the users you want to revoke access to the collection.
Select Update Roles.

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, view Remove team members.