Viewing documentation

Postman users can use two different web views while authoring documentation for their Postman Collections: private and public.

All collections are initialized with the private view. However, users must explicitly opt to publish their documentation for it to be available publicly.

Private, unpublished collections are only available to the author, while collections shared in a workspace can be accessed by the entire team. Anyone with the URL can view a published collection.

Viewing Private Documentation

Only the author can view private documentation unless the collection is shared within a team workspace.

You must be logged in to your Postman account to view private documentation. Postman Pro and Enterprise teammates with view permissions can oversee progress, while teammates with edit permissions can collaborate in writing, revising, and updating documentation.

In the Postman app, hover your cursor over your collection on the left-hand side, click the arrow (▸), then click the View in web button.

collection details view

In this private web view, you’ll be able to see each request in the collection, their descriptions, and code snippets generated from the environment and the language you’ve selected. You will also be able to post comments

view documentation

Note that this private URL is only accessible to Postman users logged in with the appropriate permissions — anyone without access to the collection itself receives an error message upon attempting to view it. To make this documentation available to others, you will need to publish it.

You can also access the documentation section from the Browse View. In the Browse view, point your cursor to the collection name and click any collection name to go to the documentation section:

Comments BrowseView

Alternatively, you can also point your cursor to any collection in your dashboard view and click it to go to the documentation section. A point to remember is clicking any collection from anywhere in Postman Dashboard will land you in the documentation section.

Viewing Public Documentation

Public documentation is accessible through a URL that Postman generates at the time of publication. This link displays immediately, and can be found in your Postman Dashboard. If you’ve opted to use a custom domain, you’ll find your published documentation link in the Postman Dashboard.

public documentation link