Introduction

Welcome to the Postman docs! This is the place to find official information on how to use Postman in your API projects.

If you're just starting to learn about APIs and Postman, you can use a variety of channels both in and outside Postman:

• Send your first request!
• Use the Bootcamp to work through lessons inside Postman—open it at the bottom right of the app.

• Explore workspaces, collections, and more that you can try out inside Postman, like the following:

  • Learn by API–walk through beginner API concepts.
  • Postman Training–Learn APIs 101, Testing and Automation, API Adoption, and API First, earning Postman badges.
  • Student Program–Take the Student Expert training, covering request configurations and test scripting.

What are you here to learn about?

If you're learning to carry out a specific task or workflow in Postman, check out the following topics to find resources:

• Making requests
• Testing APIs
• Building and managing APIs
• Publishing APIs
• Collaborating with your team
• Developing with Postman

Making requests

If you're building a client app or just need to connect to an API, check out some Postman essentials:

• Connecting to APIs
• Authorizing requests
• Grouping requests in collections
• Using variables
• Visualizing data

Testing APIs

If you're testing an API, you can use Postman to automate various parts of the process:

• Writing test scripts
• Automating workflows with the collection runner
• Capturing HTTP requests
• Test script examples

Building and managing APIs

If you're developing a back-end, working API-first, or need to monitor API performance, Postman utilities can streamline your workflows:

• Defining an API from a schema
• Monitoring test runs
• Analyzing API performance
• Mocking responses

Publishing APIs

If you're exposing an API for public use, Postman can support developer onboarding:

• Publishing documentation
• Using Run in Postman

Collaborating with your team

If you're using Postman in your company or team, check out these guides to maximize your collaboration:

• Collaborating in Postman
• Creating workspaces
• Managing Postman for an organization
• Onboarding your team

Developing with Postman

If you're integrating Postman with your CI/CD workflow or are developing with Postman APIs or libraries, check out these resources:

• Integrating with a development pipeline
• Developing with Postman utilities
• Postman API

Providing feedback

Share your thoughts on the documentation and help the Postman team to improve it for yourself and other learners! To submit feedback, please create an issue on the documentation GitHub repo or post in the community forum.

Help improve Postman and have an impact on Postman's roadmap by sending your feedback directly to Postman's developer team. To submit feature requests, create an issue on the Postman GitHub repo.

You can send requests in Postman to connect to APIs you are working with. Your requests can retrieve, add, delete, and update data. Whether you are building or testing your own API, or integrating with a third-party API, you can try out your requests in Postman. Your requests can send parameters, authorization details, and any body data you require.

For example, if you're building a client application (e.g. a mobile or web app) for a store, you might send one request to retrieve the list of available products, another request to create a new order (including the selected product details), and a different request to log a customer in to their account.

When you send a request, Postman will display the response received from the API server in a way that lets you examine, visualize, and if necessary troubleshoot it.

Importing via GitHub repositories

You must be signed in to a Postman account to use this feature.

You can import data in bulk from a GitHub repository by selecting Import > Code repository > GitHub.