About Postman elements

As a comprehensive API development platform, Postman helps you organize and document your work and complete different phases of the API development lifecycle using collections, requests, documentation, environments, Flows, API builder, mock servers, and monitors. Learn more about these integral parts of Postman.

Collections

A collection is a set of requests sent to API endpoints. A collection can also include saved responses from those requests, along with each endpoint's authorization type, parameters, headers, request bodies, tests, and settings.

Collections enable you to organize your requests using folders and subfolders according to the requirements of your API project. For example, you can group your API actions into tasks.

To try a quick example, see Create your first collection.

Requests

A request is a way for one application to access the capabilities of another application over the internet by way of an API server. A client application (like a mobile app) sends a request to the server, and after the request is processed the server returns a response to the client.

In Postman, requests can be made using the HTTP protocol, MQTT protocol, GraphQL, gRPC, WebSocket, and Socket.IO. An API endpoint is a URL that acts as the point of contact between an API client and an API server. API clients send requests to API endpoints in order to access the API's functionality and data.

The request method indicates the action you want the API to perform. Here are some of the most common methods:

• GET retrieves data from an API.
• POST sends new data to an API.
• PATCH and PUT update existing data.
• DELETE removes existing data.

To try a quick example, see Send your first API request.

To learn more about requests, see Send a request with the Postman API client.

Documentation

API documentation is a set of human-readable instructions for using and integrating with an API. It includes detailed information about an API's available endpoints, methods, resources, authentication protocols, parameters, and headers, as well as examples of common requests and responses.

Postman automatically generates documentation for your collection. To access it, from your collection, select the more actions icon , then select View documentation. You can improve your documentation by adding descriptions for your collection, folders, and requests.

Environments

In Postman, an environment is a set of variables that you can reuse in your requests and share with your team. You can reference them in request authentication, query and path parameters, request bodies, and scripts. Variables help you work efficiently, collaborate with teammates, and set up dynamic workflows.

You can use environment variables to call the same request against different servers, such as local, stage, or production. Each environment has its own set of variable values. When you change environments, selecting the correct environment points your request at the correct host (server) with the proper authentication and its defined variables. Global variables come in really handy in cases where you need to use the same variable across several collections.

Environments can also help you to collaborate on Postman data if you're working as part of a team. You can use environments to share variables and manage the visibility of sensitive data such as API keys, passwords, or tokens. Learn more about working with environments as a team in Postman.

To learn more about how variables are used in Postman in general, see Reuse data with variables and environments in Postman.

Flows

Postman Flows is a visual, low-code tool designed to streamline API workflows, making it easier for you to create, manage, and collaborate on API projects. Postman Flows provides an infinite canvas where you can functionally represent your APIs as blocks that can be connected to simulate data flow. The blocks are a set of visual abstractions. To form and visualize an application, you drag blocks, build an application, and run your workflow.

To learn more, see Build API applications visually using Postman Flows.

API Builder

Postman supports API-first development with the API Builder. You can use the API Builder to design your API in Postman and then take your API through the complete development lifecycle by developing, testing, deploying, and observing it. Your API definition can then act as the single source of truth for your API project.

When you create a new API, you can start your API development by connecting to a repository or selecting to continue without a repository.

Mock servers

A mock server enables you to simulate your API without having to configure a real API server. You can use any HTTP collection to set up a mock server. When you send a request to the mock server, Postman returns a real-world response using data from your collection.

To learn more about how to get started with mock servers in Postman, see Simulate your API in Postman with a mock server.

Monitors

Postman Monitors enable you to continuously check the health and performance of your APIs. You can create monitors that run requests in selected collections. Requests can run API test scripts, chain together multiple requests, and more. You can also schedule how often Postman runs monitored collections.

You'll be alerted to any test failures once the monitor is running, so you can identify and address issues before your API's consumers are affected.

To learn more about monitors, see Monitor health and performance of your APIs in Postman.