Grouping requests in collections

You can group your Postman requests and examples into collections to keep your workspace organized, to collaborate with teammates, to generate API documentation / test suites, and to automate request runs.

Select Collections in the left sidebar of Postman to see the list or collections in a workspace.

Collections

Click a collection to open its overview in a tab. You can open and close collection content by clicking the arrow to the left, and favorite (★) to move a collection to the top of the list. You can add sub-folders to create an extra level of nesting with your requests and examples. Use the search text-field to filter through your collections.

Contents

Creating collections

You can create a new collection by clicking + in the left sidebar, the New button > Collection, or the overview that appears when you first launch Postman.

New collection

Give your new collection a name. You can start adding requests if you don't want to specify collection details until later.

Collection opened

You can optionally specify a description for your collection (which will appear in its documentation and in the workspace when anyone opens it), authorization config, pre-request and test script code, and any variables you want to share across all requests in the collection.

To see an overview of a collection, open it from the sidebar. You can edit your collection description inline by hovering over the text and clicking the pencil icon.

Collection description

You can use markdown in your collection descriptions.

You can edit details for your collections at any time by clicking the collection to open it in a tab.

You can duplicate a collection—however you can alternatively fork it to develop collection versions.

Adding requests

You can add existing requests to collections and can create new requests inside collections. If you have a request open in Postman, click Save or Save As. Choose (or create) a collection and click Save.

Save request

To add a new request to a collection, open a new tab and save it from there, or in Collections on the left of Postman, click ... on the collection and choose Add Request.

Add request to folder

You can also create a request by clicking New > Request.

Save request

Give your request a name and optional description, then Save it to the selected collection.

You can also create and save requests from the workspace overview tab when you have no open requests or collections, or from an empty collection or folder by clicking Add a request.

To save a request from your history, select its ... menu in History on the left of Postman, and choose Save Request. Choose a collection and Save.

Save request from history

You can select multiple requests to save from your history by clicking the + button next to the date.

Managing collections

To add a folder to your collection, open its ... menu in Collections on the left of Postman, and choose Add Folder. You can then add requests and examples to the folder either by dragging them over it from inside the collection, or choosing Add a request when empty / Add Request from the ... menu.

Add request to folder

You can reorder the requests, folders, and examples inside a collection by clicking and dragging them.

Reorder collections

To delete a collection, in Collections click ... and select Delete.

If a collection is larger than 30 MB, it can't be recovered if you delete it. To avoid this, you can split the collection into smaller pieces before deleting it, or back up the collection first.

If you'd like to revert your collection to a previous state, you can open the changelog from the right of the collection overview.

Changelog

You can share your collections to a workspace, by publishing a Run in Postman button on a web page, or by sharing a public link.

Recovering deleted collections

You can recover deleted collections in Postman using Trash. Click ... next to the collection search bar and select Open Trash. You can restore the deleted collections or permanently delete them. You can alternatively open the trash from the statisbar in the bottom right corner in Postman.

Trash

Recovery options depend on your Postman plan:

  • With a free account you can recover collections up to one day old.
  • Team accounts can recover collections up to 30 days.
  • With Postman Business and Enterprise you can recover collections up to 90 days.

You cannot recover a deleted collection that is larger than 30 MB.

If you aren't able to recover a deleted collection, it may have been removed from a workspace rather than deleted. If the collection appears in another workspace, you can move it by clicking Share.

Using collections

You can use collections to power various parts of your API development, testing, and publishing workflows. Use the buttons to the right of the collection to see documentation, comments, the changelog, pull requests, and an overview of the collection including linked elements such as mocks and monitors.

Collection options

  • The Collection Runner allows you to run all requests in a collection and build testing workflows into your runs.
  • You can define scripts in your collection, and they will run for each request inside it.
  • Collection variables allow you to define values to use throughout the requests in the collection.
  • You can generate API documentation from a collection and share it publicly as well as adding it to the Postman API Network.
  • Attaching a monitor to a collection lets you schedule collection runs.
  • If you add examples to your requests, you can use mock servers to return sample data during testing and development.

You can generate collections from API specifications using the Postman API Builder.