- Installation and updates
- Sending your first request
- Navigating Postman
- New button
- Creating the first collection
- Postman account
- Keyboard Shortcuts
- Troubleshooting In-app Issues
- Authorizing requests
- Working with Tabs
- Visualize API responses
- Validating Requests Against Schema
- Generate code snippets
- Using GraphQL
- Making SOAP requests
- Capturing HTTP requests
- Debugging and logs
- Troubleshooting API requests
- Intro to collections
- Creating collections
- Sharing collections
- Commenting on collections
- Managing collections
- Version Control for Collections
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Collaborating in Postman
- Roles and permissions
- Managing your team
- Requesting access
- Team Settings
- Audit logs
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing a collection run
- Working with data files
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Documenting your API
- Authoring your documentation
- Publishing your docs
- Viewing documentation
- Custom documentation domains
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- FAQs for monitors
- Intro to Workspaces
- Creating Workspaces
- Using Workspaces
- Managing Workspaces
- Viewing changelogs and restoring collections
- Introduction to APIs
- The API Workflow
- Managing APIs
- Sharing APIs and managing roles
- Versioning APIs
- Viewing and analyzing APIs
- Validating Elements Against Schema
- Reporting FAQs
- Customizing Postman
- Find and Replace
- Purchasing Postman
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Configuring Microsoft AD FS with Postman SSO
- Setting a custom SAML in Azure AD
- Setting up custom SAML in Duo
- Setting up custom SAML in GSuite
- Setting up custom SAML in Okta
- Setting up custom SAML in Onelogin
- Setting up custom SAML in Ping Identity
- Intro to Integrations
- Custom Webhooks
- Microsoft Flow
- Microsoft Teams
- Publishing API documentation
Postman provides a multi-window and multi-tab interface for you to work on APIs. This interface design gives you as much space as possible for your APIs.
You can drag the right edge to resize the width of the sidebar. You can also minimize the sidebar for smaller screens, and show or hide the sidebar in the Status bar.
The Postman app saves every request you send in the History tab in the sidebar.
This tab creates and manages collections from the Collections tab in the sidebar.
Learn more about collections and how they accelerate the speed of your APIs.
The header toolbar contains these options:
- New button: Creates requests, collections, environments, documentation, mock servers, and monitors.
- Import button - Imports Postman collections, environments, WADL, Swagger, RAML, or cURL into Postman using files, links, or raw text.
- Runner button - Opens the collection runner.
- New window icon - Opens a new "Tab", "Postman Window" or a "Runner Window".
- Workspaces menu - Opens the Workspaces menu where you can view personal and team Workspaces, and create and manage Workspaces.
- Interceptor/Proxy icon - Manages proxy or Interceptor settings.
- IN SYNC status icon - Updates the status of your Postman account.
- Settings icon - Manages Postman app settings and finds other support resources.
- Notifications icon - Receives notifications or broadcasts.
- Heart - Love Postman? Click on this button to share the love!
- User dropdown - Displays current user and provides these options: "Profile", "Account Settings", "Notification Preferences", "Active Sessions", and "Add a new account".
Two consoles are available in Postman to see what's going on behind the scenes.
Postman console - Contains a running log of HTTP requests and responses. You can log messages from scripts. For example you could log messages in the console.log.
Note: This feature is only available in Postman's native apps.
- DevTools console - Provides diagnostic information during development. To learn how to access DevTools console logs, see Debugging and logs.
Postman has its own console, which can be used to view all the HTTP requests and responses for the current session, along with any messages the user wants to log.
Note: The new console comes with Postman app version 7.10 and later. Older version will NOT receive the new console. Once the app is updated to 7.10, it is NOT possible to revert.
The console can be opened in a number of ways:
- By going through the view option from the menu bar.
- By the Postman Console option in Postman.
- By keyboard shortcut: Command + Option + c.
The header now contains 3 components:
- A search bar, making it possible to search for a specific request.
- Filter option, allowing requests to be filtered on the basis of their message type: log, info, warning, error.
- Clear button to clear the console screen.
There is now support for 4 types of console messages:
console.log(“This is a log.”);
console.info("This is an information message.");
console.warn("This is a warning message.");
console.error("This is an error message.");
The console now shows the following four types of information for each request:
- Request headers
- Response headers
- Response body
There is now a footer section in the console, comprising of two parts:
- Console Settings: Console now supports configurable options for two things: a. Timestamp: A timestamp for the respective request. b. Hide network information: De-clutters the console if network information is not needed.
- Displays the number of errors and warnings.
Learn more about troubleshooting with console logs.
The status bar at the bottom of the Postman interface gives you a convenient way to:
- Show or hide the sidebar.
- Search in collections, environments, and globals.
- Open the Postman console.
- Select either a single or two pane layout.
- Open the keyboard shortcuts.
- Get help or provide feedback.
Postman lets you use multi-tab and multi-window configurations to work on multiple requests or even multiple collections together and simultaneously.
To open a new tab in Postman, press the + icon in the builder or use the CMD/CTRL + T shortcut. From the menu bar, you can also select "New Tab" from the File menu to create a new tab.
When you right click a tab name, the menu allows you to duplicate or close tabs. If any tab has unsaved changes as you attempt to close the tab, Postman prompts you to save your changes.
Busy tabs ensure you don't lose your current request, even if it isn't in a collection. When you're in a busy tab and open a new request from the sidebar, Postman opens the request in a new tab and doesn't replace or interfere with the request in the previous busy tab.
What makes a tab busy? When you work in a tab it becomes busy. For example, when you receive a response or make a change that's not yet saved (reflected by an orange dot on the tab), the tab is busy.
By default, Postman assumes you want to work on one collection request in one tab. When you open a request from the sidebar, Postman opens a new tab when an existing tab has unsaved changes. If not, the request takes over the current tab. You can always open a request in a new tab from the sidebar under the Collections tab. Right click a request and select "Open in New Tab".
Postman offers several tab actions to help you manage your work.
To access the Tab menu, click the three dots on the right side of a tab. A dropdown menu appears with options to manage your tabs.
- Duplicate Current Tab
- Close Current Tab
- Force Close Current Tab
- Close All but Current Tab
- Close All Tabs
- Force Close All Tabs
When you "Force Close Current Tab" or "Force Close All Tabs", the tab closes immediately without prompting you to save your work in the tab.
When you "Close Current Tab", "Close All but Current Tab", or "Close All Tabs", a dialogue box appears with an option to save your work.
In the request builder, you can drag and drop tabs to reorder them, open a new request in a new tab, or in a new Postman window. You also can open multiple windows using the New Window icon in the header toolbar or the keyboard shortcut.
To close a tab, right click the tab to display the Tab menu, and click the Close button. Or click the X icon on the right side of the tab to close it.
To force close a tab, press ALT and click the X icon on the right side of the tab.
Working with large amounts of data can be cumbersome and time consuming. Postman's data editor lets you view and manipulate data in a fast, effective, and elegant manner. Since most users work with data in spreadsheets, Postman leverages those features for the data editor design to make it a familiar experience.
Note: The UI images in this section do not reflect the current UI that features the New button.
We've configured the available horizontal and vertical space more effectively to optimize the data you can display up front.
On hover, relevant features display for a specific row to reduce clutter in the interface and help you focus on the most relevant data.
You can use the keyboard shortcuts to navigate the data editor.
Drag your mouse to select multiple rows.
You can select and copy multiple rows and then paste them in a different places (such as 'params').
You can display the information you want to see up front. If you navigate to a place with a large amount of data, the UI element auto expands to show the complete information in the data editor as well as the URL bar.
You can change the width of the key and value columns when you drag the boundary on the right side of the ‘key’ column header.
The data editor supports sending multiline values. Press 'Enter' in a key or value field to expand it and move the cursor to a new line.