Postman provides a variety of views and controls for managing your API projects.
The Postman UI is made up of the following components:
- The left sidebar provides access to your collections, APIs, environments, mock servers, monitors and request history.
- The header allows you to create workspaces, access reports, explore the public API network, search within Postman, view sync status and notifications, move and invite collaborators to workspaces, capture requests and cookies, access your settings, account, and Postman plan.
- The center area is where you build and work with requests.
- The status bar along the bottom allows you to show/hide the sidebar, find and replace, and open the console on the left. On the right you can launch the Bootcamp, collection runner, trash, two pane view, and access help resources.
On the right panel, you will see icons to view the documentation, comments, code and request info.
To open the documentation tab, select the request under your collection and select the Documentation icon on the right panel.
Select View complete collection documentation to open the documentation in a new tab.
To publish a documentation for a collection, see Publishing your documentation.
To open the comments tab, select the request under your collection and select the Comments icon on the right panel. You can switch to comment mode to leave comments on a specific part of the request, including parameters, headers, body and tests.
To learn more about comments, see Commenting on collections.
To open the code snippets tab, select the request under your collection and select the Code icon on the right panel. See more on Generating code snippets.
You can also drag to resize the panes in the Postman UI.
You can declutter your workspace by collapsing panes. Use the buttons at the bottom-left to hide the sidebar and at the bottom-right to toggle between single and two pane view.
When a request is selected in Postman, you'll see a Related Collections (light bulb) icon on the right panel.
You can select the icon to view public collections from the API Network that share the same base URL as your request and include API documentation to help you get started.
You can select any recommended collection to view its contents and documentation. You can also directly fork a recommended collection and utilize it to quick-start your development.
You can access universal search by selecting Search Postman at the top of Postman, or by using the keyboard shortcut
Command + K.
Enter your search string and change the scope of search to narrow down your search results to all of Postman, your personal or team space, or the Public API Network. You can also change the scope of your search to Workspaces, Collections, APIs or Teams.
For signed in users, the default search scope on workspaces is Team and on explore is Public API Network. For signed out users, all results will contain only public resources since they will not have any private data.
If you do not find what you are looking for in the list of results, select Search all workspaces, collections, APIs and teams and you will find all the results in one page.
The left navigation on the search results page lists the scope and entity type. You can change these options to further filter your results.
You can sort the results using Sort by on the right, ordered by Most relevant (default), Most views, or Most recent.
Depending on the entity type, the search results will contain different information:
- For workspaces, the search result contains the workspace type, summary, who published it, and when was it published.
- For collections, the search result contains the workspace type, whether the collection is a fork or not, who published it, and when was it published.
- For APIs, the search result contains the name and summary of the API, the API's owner (either an individual user or a team), and the type of workspace.
- For teams, the search result contains the name and summary of the team. Select the team name and you will be redirected to the team profile.
In the Postman app, you can search the current workspace by selecting Find and Replace in the status bar at the bottom left of Postman, or by selecting ⌘+Shift+F or Ctrl+Shift+F.
Enter your search string and optionally choose which entities to return, entering replacement text if necessary.
Postman will search tabs, collections, and variables. You can select an item directly in the search results to open an entity.
Find and Replace is not available in Postman for Web.
You can access a history of the requests you've made in Postman in the History tab on the left of Postman. If you're signed into a Postman account, your history will sync across devices.
Select a request to open it again. Select + to save the request to a collection. Toggle Save Responses to save request responses so that you can view what was returned by a request when you open it from your history.
The history also includes the collection runs executed. These remain as the summarized version of the run and aren't logged as single requests. The Save Responses option can't be used with requests from collection runner.
The View more actions menu allows you to save, monitor, document, or mock a request. Use the delete (trash icon) or Clear all options to remove requests from your history. You can multi-select requests by pressing
Control and selecting the requests.
You can send requests in Postman by opening a new tab. Select + in the center of the screen, or press
Command/Control + T.
If you open a request and do not edit or send it, then open another, the first tab will be replaced by the second. While the tab is in Preview mode it will display in italics.
You can have multiple tabs open at the same time as you work, and can drag tabs to rearrange them. Select to manage tabs and access recent tabs.
Duplicating a tab does not mean creating a second request to the same endpoint—when you duplicate a tab any edits you make will affect the original request.
Postman will display a dot on any tabs with unsaved changes.
A tab may indicate a conflict if you or a collaborator changes it in another tab or workspace. Postman will prompt you to resolve any conflicts that occur.
You can toggle whether Postman opens requests in new tabs or not in the Settings, as well as configuring whether Postman prompts you when closing tabs with unsaved changes.
The best way to get to know Postman is by firing up the Bootcamp on the bottom-right and working through the lessons.
You can also access Bootcamp together with other resources for getting started and staying up to date by opening Home in the upper-left corner.
Next try sending your first request!
Last modified: 2022/01/12