{ "componentChunkName": "component---src-templates-doc-jsx", "path": "/docs/getting-started/navigating-postman/", "result": {"data":{"markdownRemark":{"html":"

Postman provides a variety of views and controls to manage your API projects.

\n

\"Postman

\n

The Postman UI includes the following components:

\n\n

On the right panel, you can see icons to view the documentation, comments, code, and request info.

\n\"Right\n

To open the Documentation tab, select the request under your collection and select the Documentation icon \"Mini on the right panel.

\n\"Documentation\n

To open the documentation in another tab, select View complete collection documentation.

\n\"Overview\n

To publish a documentation for a collection, see Publishing your documentation.

\n

To open the Comments tab, select the request under your collection and the Comments icon \"Mini 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.

\n

\"Overview

\n

To learn more about comments, see Commenting on collections.

\n

To open the Code snippets tab, select the request under your collection, and then select the Code icon \"Code on the right panel. For more information, see Generating code snippets.

\n\"Code\n

Resizing and collapsing panes

\n

You can drag the bottom panel to resize the panes in the Postman UI.

\n

\"Resizing

\n

You can also declutter your workspace by collapsing panes. Use the button at the bottom-left to hide the sidebar and the button at the bottom-right to toggle between a single and two pane view.

\n

\"general

\n

Related Collections

\n

When a request is selected in Postman, you can see a Related Collections (light bulb) icon \"Related on the right panel.

\n

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.

\n\"Related\n

You can select any recommended collection to view its contents and documentation. You can also directly fork a recommended collection to quick-start your development.

\n

Universal search

\n

You can access universal search by selecting Search Postman at the top of Postman, or by using the keyboard shortcut Command + K.

\n

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.

\n

\"Changing

\n
\n

For signed-in users, the default search scope on workspaces is Team. On explore, the default is Public API Network. For signed-out users, the results only include public resources and don't contain private data.

\n
\n

If you don't find what you are looking for in the list of results, select Search all workspaces, collections, APIs and teams and you can find all the results in one page.

\n\"Search\n

The left navigation on the Search results page lists the scope and entity type. You can change these options to further filter your results.

\n\"Universal\n

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

\n\"Search\n

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

\n\n

Find and replace

\n

In the Postman app, you can search the current workspace by selecting Find and Replace in the status bar at the bottom left, or by entering Command + Shift + F or Ctrl + Shift + F.

\n

Enter your search string and, optionally, choose which entities to return, entering replacement text if necessary.

\n

\"Find

\n

Postman searches tabs, collections, and variables. You can select an item directly in the search results to open an entity.

\n
\n

Find and Replace isn't available in Postman for Web.

\n
\n

History

\n

You can access a history of the requests you've made in the History tab on the left. If you're signed into a Postman account, your history syncs across your devices.

\n\"History\n

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.

\n

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.

\n

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 select multiple requests by pressing Command or Control and selecting the requests.

\n

Tabs

\n

Tabs allow you to organize and work between multiple requests.

\n

Opening a new tab

\n

To open a new tab, select + in the middle of the screen.

\n
\n

Keyboard shortcut: You can also select Command + T or Ctrl + T on your keyboard to open a new tab.

\n
\n\"Open\n

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.

\n

You can set whether Postman opens requests in new tabs. Select the gear icon \"Settings to open Settings. Under Requests, use the toggle next to Always open requests in a new tab to turn this option on or off.

\n

Managing tabs

\n

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

\n

To manage your open tabs or to access recently closed tabs, select the three dots \"Three to open a menu with action options:

\n\n\"Manage\n

You can also manage your open tabs or open a new tab by right-clicking on an existing tab:

\n\n\"Manage\n
\n

Closing unsaved tabs: You can set whether Postman asks whether you want to save when you close a tab that contains changes. Select the gear icon \"Settings to open Settings. Under Requests, use the toggle next to Always ask when closing unsaved tabs to turn this option on or off.

\n
\n

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

\n\"Scroll\n

Saving or discarding changes

\n

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

\n

Viewing conflicts

\n

A tab may indicate a conflict if you or a collaborator changes it in another tab or workspace. Postman prompts you to resolve any conflicts that may occur.

\n\"Tab\n

Next steps

\n

The best way to get to know Postman is by firing up the Bootcamp on the bottom-right and working through the lessons.

\n

\"Bootcamp\"

\n

To find more resources to get started with Postman, select Home in the upper-left corner.

\n

\"Bootcamp

\n

Try sending your first request!

","frontmatter":{"title":"Navigating Postman","contextual_links":[{"type":"section","name":"Prerequisites","url":null,"blog_tag":null},{"type":"link","name":"Download and Install","url":"https://www.postman.com/downloads/","blog_tag":null},{"type":"section","name":"Additional Resources","url":null,"blog_tag":null},{"type":"subtitle","name":"Videos","url":null,"blog_tag":null},{"type":"link","name":"Bootcamp | Postman Level Up","url":"https://youtu.be/cCruwkHi9o4","blog_tag":null},{"type":"link","name":"History | Postman Level Up","url":"https://www.youtube.com/watch?v=9VBTKwUCsGw&list=PLM-7VG-sgbtC5tNXxd28cmePSa9BYwqeU&index=4","blog_tag":null},{"type":"link","name":"Universal Search | Postman Level Up","url":"https://www.youtube.com/watch?v=1K6Pl6o_tj8","blog_tag":null},{"type":"subtitle","name":"Related Blog Posts","url":null,"blog_tag":null},{"type":"link","name":"Postman Now Recommends Related Collections in Requests","url":"https://blog.postman.com/postman-now-recommends-collections-in-requests/","blog_tag":null},{"type":"link","name":"How Postman Designers Built the New Universal Search Feature","url":"https://blog.postman.com/how-postman-designers-built-the-new-universal-search-feature/","blog_tag":null},{"type":"section","name":"Next Steps","url":null,"blog_tag":null},{"type":"link","name":"Sending your first request","url":"/docs/getting-started/sending-the-first-request/","blog_tag":null}]},"fields":{"slug":"/docs/getting-started/navigating-postman/","lastModifiedDate":"2022/03/04\n"}}},"pageContext":{"slug":"/docs/getting-started/navigating-postman/"}}, "staticQueryHashes": ["3840739351","63159454"]}