Navigating Postman

Postman has a variety of tools, views, and controls to help you manage your API projects. This guide is a high-level overview of Postman's primary interface areas:

Postman app

The header enables you to create workspaces, access reports, explore the Postman API Network, search in Postman, view sync status and notifications, and access your settings, account, and Postman plan.

  • ← → - (Available on the Postman desktop app) Navigate backward and forward through pages you've visited within Postman.

    Postman header left side
  • Home - Go to your personal home page, which includes your recently visited workspaces, and links to resources for your team if applicable.

  • Workspaces - Search for workspaces, view your recently visited workspaces, or create a new workspace.

  • API Network - Explore the Postman API Network and access your team's Private API Network.

  • Search icon Search Postman - Search all workspaces, collections, requests, APIs, Flows, and teams in Postman. For more details on searching in Postman, see Search Postman.

    Expanded view of the Search Postman field
  • Invite - If you have an Admin role on a workspace, you can invite other users to collaborate.

    Postman header right side
  • Settings icon Settings - Access Postman settings and other Postman resources.

  • Notifications icon Notifications - View recent activity from your team, get notifications about Postman updates, and see pull requests, comment activity, and other important information.

  • Your avatar - View your profile, access your account and notification settings, see all active sessions for your account, or sign out of your account.

  • Team (paid plans) or Upgrade (free plan) - View resource usage and access your billing dashboard and other account management tools.

Search Postman

To search in Postman, select Search Postman in the header then enter your search terms. You can also use the keyboard shortcut ⌘+K or Ctrl+K. To change the scope of your search, select the scope dropdown list to the left of the search bar. You can search all of Postman, your team, the Private API Network, and the Postman API Network. You can also specify the element type you'd like to search for, such as Workspaces, Collections, or Teams.

You can search by tag names that team members have added to collections, APIs, and workspaces (Enterprise plans only). To search by tag names, select Search Postman in the header then enter your search using the tag:tag-name format. For example, if an API has the tag "production", enter tag:production to return the API in your search results.

For signed-out users, search results only include public resources.

If you don't find what you are looking for in the list of results, select See all results to see all the results in one page.

Search all

The Search results page lists the scope and element type. You can change these options to further filter your results.

You can also sort results using Sort by on the right by selecting Most relevant (default), Most views, or Most recent.

Depending on the element type, the search results contain different information:

  • For workspaces, the search result shows the workspace type, summary, who published it, and when was it published.
  • For collections, the search result shows the workspace type, whether the collection is a fork or not, who published it, and when was it published.
  • For APIs, the search result shows the name and summary of the API, the API's owner (either an individual user or a team), and the workspace type.
  • For teams, the search result shows the name and summary of the team. Selecting the team name redirects you to the team profile.

The Postman sidebar provides access to the fundamental elements of Postman:

Sidebar focused on Collections

To see the task options that are available for elements in the sidebar, hover over the element's name then select the more options icon More actions icon. The task options will vary depending on the type of element.

For collections, folders and requests inside a collection, and requests in History, you can select more than one element at a time. Select and hold or Ctrl, then select the desired elements. For elements that are next to each other, select and hold Shift, then select the desired elements. For collections and their contents, you can also use keyboard shortcuts for tasks like copying, pasting, and deleting.

You can select New in the sidebar to create requests, collections, and other common Postman elements. Select an element to create it in your workspace. You can also pin the elements you use most often. To pin an element, hover over an element and select the pin element icon Pin element icon. To unpin an element, hover over the pinned element and deselect the pin element icon Unpin element icon.

Pin elements

To hide the sidebar, select the hide sidebar icon Hide sidebar icon from the footer or right-click in an empty part of the sidebar and select Collapse sidebar. You can also right-click in the sidebar to show or hide labels, collapse the sidebar, and configure the sidebar.

Add elements to the sidebar

By default, the sidebar shows only Collections, Environments, and History. You can add other elements to the sidebar including Flows, Environments, and Monitors. To add an element to the sidebar, do the following:

  1. In your workspace's sidebar, select the Configure workspace sidebar icon Configure workspace sidebar icon.

  2. In Workspace settings, select the toggle Toggle next to the element you want to add to the sidebar.

    Select a toggle

History

To access the requests you've made, select History in the sidebar. When you're signed in to Postman, your history syncs across your devices.

Select a request to open it again in a new tab. To select more than one request, select and hold or Ctrl, then select the requests.

History Request

Your history also includes collection runs. These remain as the summarized version of the run and aren't logged as single requests.

  • Select the add icon + to save the request to a collection.
  • Select the delete icon Delete icon to remove the request from your history.
  • Select the more actions icon More actions icon to access other actions, including creating a monitor, documentation, or mock server for the request.

When you make requests in a shared workspace, your request history is visible to you but not to other team members in the workspace.

Clearing your history

To remove all requests from your history, select the more actions icon More actions icon next to the History search bar, then select Clear all.

Saving responses in history

To save request responses in your history, select the more actions icon More actions icon next to the History search bar, then turn on Save Responses.

You can't use the Save Responses option with requests from Collection Runner.

Workbench

Whether you're working with a collection, an API, or another element type, the Postman workbench is where you do the majority of your work. Tabs enable you to organize your work, while the right sidebar gives you access to element-specific tools like documentation. The environment selector and environment quick look enable you to manage variables.

Tabs

Tabs allow you to organize and work between requests.

This section describes how tabs work in the Postman desktop app. By default, tabs in the Postman web app work this way as well. You can choose to use browser tabs instead, which enables you to use a different tab for each open Postman element. For more information, see Browser tabs in the Postman web app.

Opening a new tab

To open a new tab, select + in the workbench.

You can also select ⌘+T or Ctrl+T to open a new tab.

Open a new tab

If you open a request and don't edit or send it, then open another request, the second tab replaces the first tab. When the tab is in preview mode, it displays in italics.

You can set whether Postman opens requests and other sidebar items in new tabs. Select the settings icon Settings icon in the header and select Settings. Under User interface, select Always open sidebar items in new tab to turn this option on or off.

Saving or discarding changes

If a tab has unsaved changes, Postman displays a dot next to the tab name. Select Save icon Save to save the changes. To close the tab and discard changes, select the close icon Close icon then select Don't save.

Renaming and linking elements

To rename an element, select the element's name and enter a new name.

Rename elements

To copy a link to an element, hover over the element's name in the workbench to display the link icon Link icon. Select the link icon to copy the element's URL to your clipboard.

Copy link to elements

If the element is in a personal workspace that no one can access, a popup window will display when you select the link icon. The popup window enables you to invite people to your personal workspace before sharing the link. To invite people to your personal workspace, select Invite People. To learn more about inviting people to collaborate in a workspace, see Sharing workspaces.

Invite people before sharing link to element

Viewing conflicts

If you are making changes to the same request in two different tabs, before you can save the changes, the tab alerts you to a conflict. Selecting the tab displays a message that the request was modified since the last time you opened the tab. By selecting Save, you can either override the previous change or save the request as a new one.

Tab displaying a conflict

Managing tabs

You can have many tabs open at the same time. To rearrange your open tabs, select and drag them in the desired order.

To manage your open tabs, right-click the open tab to activate a menu with action options:

  • Duplicate Tab - (Available on the Postman desktop app) Duplicates the current tab. This doesn't create a copy of the request, so when you duplicate a tab any edits you make are reflected in the original request.
  • Close Tab - Closes the current tab. If the tab has unsaved changes, Postman asks if you want to save before closing.
  • Force Close Tab - Closes the current tab without saving any changes.
  • Close Other Tabs - Closes all tabs except the one you're working in.
  • Close All Tabs - Closes all tabs. If any tabs contain unsaved changes, Postman will ask if you want to save before closing.
  • Force Close All Tabs - Closes all tabs without saving any changes.
Manage tabs using the actions menu

Closing unsaved tabs. You can set whether Postman asks you to save when you close a tab that has changes. Select the settings icon Settings icon in the header and select Settings. Under General > Request, select Always ask when closing unsaved tabs to turn this option on or off.

If you have a lot of tabs open, they might overflow the area of the tab bar. To go to tabs that are outside the viewable area, select the arrows next to the tab bar.

Scroll to view tabs

To search open tabs or access recently closed tabs, select the tab search dropdown list.

Search tabs

Browser tabs in the Postman web app

By default, the Postman web app uses in-app tabs like the Postman desktop app does. You can optionally choose to use browser tabs instead. With this setting turned on, there is only one collection overview or request in the main work area at a time, and you can open more Postman elements in new browser tabs. This enables you to work across workspaces or to use different environments in the same workspace.

If you've saved changes to a request, when you select a new element Postman will open it in the main work area area. If the request has unsaved changes, Postman will prompt you to save or discard your changes.

To open a workspace, environment, or request in a new browser tab, select and hold ⌘+Shift or Ctrl+Shift and select the element you want to open.

To open an in-app link in a new browser tab, select and hold or Ctrl and select the link you want to open.

To turn this behavior on or off in the Postman web app, select the settings icon Settings icon in the header, then select Remove tabs in the User interface section.

The right sidebar gives you access to more tools, including documentation, comments, code snippets, and request information, based on which kind of Postman element you select.

Postman right sidebar showing Documentation view
ToolAvailable forDescription
Documentation Documentation iconRequestsView the documentation for a specific request.
Comments Comments iconCollections, requests, APIsLeave comments on a specific part of a request or an API.
Code Code snippet iconRequests, APIs, historyGenerate code snippets in a variety of languages and frameworks that you can use in other apps.
Related requests Related requests iconRequests, historyView public requests from verified or popular collections on the Postman API Network that are related to your request.
Info Information iconCollections, requests, APIs, environments, mock servers, monitors, FlowsSee details about the element, including its ID, when it was created, who created it, and more.
Changelog Changelog iconCollections, APIsUse the changelog to see changes that you and your collaborators have made. Available on Postman paid plans.
Pull requests Pull request iconCollections, environmentsView any pull requests for a Postman element.
Forks Fork iconCollections, environments, FlowsView any forks of a Postman element.
Activity feed Activity feed iconMonitorsView the activity feed for a monitor.
Flow Element Info Flow Element Info iconFlowsView the input and output of the selected block.
Released Versions Released Versions iconFlowsView your released Flows.
Execution issues Execution issues iconFlowsView a Flow's execution issues, if any.

Environment selector and environment quick look

The environment selector enables you to choose which environment to use in your work. Select an environment from the menu to set it as the active environment, which gives you access to the variables in that environment. You can also pin environments to collections to show other Postman users which environments work with that collection.

Environment selector

To check a variable value at a glance, use the environment quick look icon Environment quick look icon.

Quick Help

If you have a quick question about something in the Postman app, look for "learn more" help links or the information icon Information icon in the Workbench. These will open context-sensitive help from the Postman Learning Center in a side pane in the Postman app.

You can open the displayed Quick Help in a new web browser window with the open in icon Open in icon.

The footer on the bottom of Postman enables you to find and replace text, open the Console, capture requests and cookies, and access several other tools.

Postman footer left view
  • Hide sidebar icon Hide sidebar - Close or reopen the sidebar.
  • Checkmark icon Sync status - See if you are connected to Postman's servers and your data is syncing.
  • Search icon Find and replace - (Available on the Postman desktop app) Search the current workspace. You can also use the shortcuts ⌘+Shift+F or Ctrl+Shift+F. Enter your search string then select Find. Limit your search to a specific element type by selecting Collections, Environments, Globals, or Open tabs. To replace your search term in a selected element, select Replace in selected.
  • Console icon Console - Inspect and debug your Postman requests.
Postman footer right view
  • Postbot icon Postbot - Open the Postbot AI assistant to ask questions and search for answers.
  • Git branch icon Git branch icon - For APIs using a Git repository, switch branches and open the Source Control pane.
  • Runner icon Runner - Open the Collection Runner.
  • Select Postman Agent - (Available on the Postman web app) Select which Postman Agent is used: the Cloud Agent, Desktop Agent, Browser Agent, Interceptor Agent, or auto-select an agent.
  • Capture icon Start Proxy - (Available on the Postman desktop app) Start the Postman proxy.
  • Cookies icon Cookies - View, manage, and sync cookies.
  • Vault icon Vault - Store vault secrets in your Postman Vault, and use them in your local instance of Postman.
  • Delete icon Trash - Recover or permanently delete any deleted collections.
  • Two pane view icon Two-pane view - Toggle between a single pane view and a two pane view.
  • Help icon Help - Access more resources, including release notes and Postman Support.

Last modified: 2024/05/07