Share and collaborate on Postman Collections

You can collaborate on Postman Collections with your team and other Postman users. Share collections with others, watch collections to get notified when changes are made, and comment on collections to let others know your thoughts. You can also use collection tags to help organize and find collections.

Forking offers another way to collaborate on collections. You can fork a collection into your own workspace, make changes, and then create a pull request to merge your changes back to the original collection.

Share a collection

To share a collection with other Postman users, use any of the following methods:

  • Select a collection in the sidebar, then select Share in the workbench. You can enter the users you want to share the collection with, or copy a link you can share with others. Learn more about sharing elements in Postman.

    To share a link with users who aren't in your Postman team, turn on Allow Guests to join your team and view this collection with the link. Learn more about sharing collections with guest users in your organization.

  • In the workbench, select the link icon Link icon next to a collection's name to copy a link to your clipboard. You can then share the link with others.

    To share a link to a collection, folder, request, or example with an active environment selected, choose an environment using the environment selector and copy the element's link to your clipboard. You can then share the link with others.

  • Move the collection to a shared workspace. In the sidebar, select the more actions icon More actions icon next to a collection, then select Move. Learn more about moving Postman elements.

  • Publish a Run in Postman button. Others can use the Run in Postman button to view and run your collection in their own environment.

  • If you're on an Enterprise plan, you can add the collection to your team's Private API Network.

Watch a collection

If you watch a collection, Postman notifies you when a change is made to the collection. Changes you'll get notified about include adding a request, changing a request, adding or updating variables, editing pre-request or post-response scripts, and adding or deleting a folder.

You can watch collections in private, team, partner, and public workspaces. You can't watch collections in personal workspaces.

To watch a collection, do the following:

  1. Select Collections in the sidebar and select a collection.

  2. Select the watch icon Watch icon in the workbench.

    Collection watching

To view notifications for a collection you're watching, do the following:

  1. Select the notifications icon Notification icon in the Postman header.

  2. Select View changelog to view a list of changes made to the collection.

    Notification Collection Watching

You'll also get an email about the change and who made it. Select View changelog in the email to view the full changelog in Postman.

To view changes for a collection at any time, select the collection in the sidebar and then select the changelog icon Changelog icon in the right sidebar.

If you create a collection and change it from the same Postman account, you won't receive notifications for changes you make to that collection.

Add comments to a collection

You can add a comment to a collection to collaborate with your team or give feedback to other users.

  1. Select Collections in the sidebar and select a collection.
  2. Select the comments icon Comments icon in the right sidebar and enter your comment.
  3. (Optional) Select the Watch collection checkbox to be notified when there are changes to the collection. Learn more about watching a collection.
  4. Select Comment to add your comment.

To learn more about using comments to collaborate on collections and requests, go to Comment on collections, folders, and requests.

Tag a collection

Tagging collections is available on Postman Enterprise plans. You can apply shared tags to workspaces, collections, and APIs. Tags can be 2 to 64 alphanumeric characters in length and must start with an alphabetical character. Tags can contain dashes but no other special characters or spaces. You can add up to five tags.

You can use shared tags to organize and search for collections. Once you add tags to a collection, you can select a tag to search for collections and other elements with the same tag.

To learn more about searching using tags in Postman, go to Search Postman. You can search by tags in your Private API Network. Use tags to search for elements on your Private API Network. You can also use tags to search for elements to add and elements to request to add to your Private API Network.

To add tags to a collection, do the following:

  1. Select Collections in the sidebar and select a collection.

  2. Select the Tags section to edit it.

    Add tags to a collection
  3. Select an existing tag or add a new tag. To add a new tag, enter the tag name and select Create "tag-name".

    Add new tags to a collection
  4. Select outside of the Tags section to save your changes.

To remove tags from a collection, do the following:

  1. Select Collections in the sidebar and select a collection.

  2. Select the Tags section to edit it.

  3. Select the close icon Close icon next to a tag.

    Remove tags from a collection
  4. Select outside of the Tags section to save your changes.

Fork a collection

If you don't have edit access to a collection, you can make changes by forking the collection into your own workspace. You can then create a pull request to submit your changes to the original collection.

To fork a collection, do the following:

  1. Select Collections in the sidebar and select a collection.
  2. Select the fork icon Fork icon in the workbench.

To learn more, go to Version control for Postman collections and environments.

View pull requests, forks, and collection details

To get more details about a collection, select the collection in the sidebar and then do any of the following:

  • To view pull requests for the collection, select the pull request icon Pull request icon in the right sidebar.
  • To view forks created from the collection, select the fork icon Fork icon in the right sidebar.
  • To view more information about the collection, including mock servers, monitors, and integrations, select the information icon Information icon in the right sidebar.

Last modified: 2024/09/10