- 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
- Importing and exporting data
- Working with OpenAPI
- Collaborating in Postman
- Roles and permissions
- Managing your team
- Requesting access
- Team Settings
- Audit logs
- Your private API network
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing collection runs
- 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
- Using the API Builder
- Managing and Sharing APIs
- Versioning APIs
- Viewing and analyzing APIs
- Validating API Elements Against Schema
- Customizing Postman
- Find and Replace
- Purchasing Postman
- Onboarding Checklist
- 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
The Postman response viewer helps to ensure the correctness of API responses. An API response consists of the body, headers, and the status code. Postman organizes body and headers in different tabs. The status code and the completion time of the API call is visible next to the tabs.
The response also contains the HTTP specification default description. However, API authors can also add custom messages.
If a request has been saved in a collection, you can save responses for that request. Once the response has been returned, click the Save Response button. Enter a name to call your saved response. All responses saved for a request will be available as an example whenever you load the request. Click the Examples dropdown in the top right to view and select the saved examples.
The Postman Body tab gives you several tools to help you understand the response quickly. You can view the body in one of three views - pretty, raw, and preview.
The pretty mode formats JSON or XML responses so they are easier to view. Nobody wants to scroll through a minified single line JSON response looking for that elusive string! Links inside the pretty mode are highlighted and clicking on them can load a GET request in Postman with the link URL. For navigating large responses, click on the down-pointing triangles (▼) on the left to collapse large sections of the response.
For Postman to automatically format the body, make sure the appropriate Content-Type header is returned. If not, you can force formatting through JSON or XML. You can force JSON formatting under the General tab in the SETTINGS modal. To do so. select "JSON" from the "Language detection" dropdown.
Finding items in responses: You can use CMD/CTRL + F to open the search bar, and CMD/CTRL + G to scroll through results. See the complete set of keyboard shortcuts.
The raw view is a large text area with the response body. It can indicate whether your response is minified.
You can maximize the body to occupy the whole Postman window. Use this view if you plan to work with the response for an extended period of time.
If your API endpoint returns an image, Postman will detect and render it automatically. For binary response types, you should select “Send and download” which will let you save the response to your hard disk. You can then view it using the appropriate viewer. This gives you the flexibility to test audio files, PDFs, zip files, or anything that the API throws at you.
Headers are displayed as key-value pairs under the Headers tab. Hovering over the header name can give you a description of the header according to the HTTP spec. If you are sending a HEAD request, Postman will show the headers tab by default.
Postman will display network data when your API returns a response.
Hover over the globe icon to see the local and remote IP addresses for the request you sent.
When you make
https requests, the Network information will display a padlock and will include detail of any certificate verification.
If you have SSL verification enabled in the global settings and verification fails, Postman will indicate the error in the response area. Click the link to disable verification globally and immediately run the request again. If SSL is disabled globally but enabled for your request, you will see the error and a link to open the console.
Note that if you click Disable SSL Verification you will need to turn it back on if you want to verify certificates for future requests. To enable it globally, open Settings (wrench button at the top left of Postman) and use the switch in the General section. To enable it just for the current request, use the request Settings tab.
If you have SSL verification turned off and your request returns a certificate verification error, you will see the detail in the Network information pop-up.
For requests that return data successfully but with a certificate verification failure, the console will display a warning.
Postman automatically calculates the time it took for the response to arrive from the server. This is useful for some preliminary testing for performance.
Postman breaks down the response size into body and headers. The response sizes are approximate.
Cookies sent by the server are visible in a dedicated tab. To manage cookies in Postman the native apps, use the MANAGE COOKIES modal. If you're working in the Postman Chrome app, you can use the Interceptor extension to help manage cookies.
You can also see the results of the tests that were run against the request. Learn more about testing in Postman.