Get started in Postman

View as Markdown

Welcome to the Postman Docs! This is the place to find official information on how to use Postman in your API projects, whether you work in the desktop app, the web app, the command line with the Postman CLI, or through a coding agent using installed agent skills.

To learn how to accomplish a specific task or workflow in Postman, check out the following topics:

Quick start

Get up and running with Postman. Learn how to use Postman to send requests, and write tests.

Install

Download the Postman desktop app for Windows, macOS, or Linux, or use the Postman web app.

Postman CLI

Install the Postman CLI to run collections, check API governance, manage mocks, and more from the command line. Coding agents can use the CLI and installed agent skills to work on your APIs directly.

Navigate

Once you’re in Postman, check out how to navigate the interface.

Account

Create a Postman account. Then, learn how to set up and customize Postman and your profile.

Use

Send API requests, group them in collections, and secure your data with Postman Vault. You can also send requests and search for Postman elements from the command line with the Postman CLI.

Test

Write scripts to add dynamic behavior to requests and collections. Perform API tests, add dynamic parameters, pass data between requests, and more. You can also run your tests from the command line and CI pipelines with the Postman CLI.

Collaborate

Collaborate with your team on API projects. Create internal workspaces, where team members can share, version, and discuss their work and collaborate on API projects.

Design

Use Spec Hub to design your API’s structure, or use types in collections to design your API with the Postman Collection format. Check your specifications against governance rules from the command line with the Postman CLI.

Administer

Deploy Postman at scale to your team. Customize and secure your team’s experience, and manage your team and plan.

Troubleshoot

Having trouble? Learn how to troubleshoot app issues.

Share your thoughts on the Postman Docs and help the Postman team continue improving them for the Postman community. To submit feedback, scroll to the bottom of any document and choose thumbs up or thumbs down, then provide more details (optional) and click Feedback.