The Postman API has several endpoints to help you integrate Postman even more deeply with your development toolchain. You can add new collections, update existing collections, update environments, add and run monitors directly through the API. This API allows you to programmatically access data stored in your Postman account with ease.
The easiest way to get started with the API is to click the Run in Postman button at the top of the Postman API documentation page and use the Postman app to send requests.
You need a valid API Key to send requests to the API endpoints. Postman users can get a key from the integrations dashboard.
The API is rate limited.
Using the API, you can add and update collections, environments, and users. Run monitors, create a mock server, and so much more.
Review more documentation for the Postman API.
An API Key is required to be sent as part of every request to the Postman API, in the form of an
X-Api-Key request header.
If you do not have an API Key, you can easily generate one by heading over to the Postman Integrations Dashboard, and click the “Get API Key” button.
An API Key tells our API server that the request it received came from you. Everything that you have access to in Postman is accessible with an API Key that is generated by you.
For ease of use inside Postman, you could store your API key in an environment variable called
postman_api_key and this collection will automatically use it to make API calls.
API access rate limits are applied at a per-key basis in unit time. Access to the API using a key is limited to 60 requests per minute. In addition, every API response is accompanied by the following set of headers to identify the status of your consumption.
||The maximum number of requests that the consumer is permitted to make per minute.|
||The number of requests remaining in the current rate limit window.|
||The time at which the current rate limit window resets in UTC epoch seconds.|