Postman API

The Postman API endpoints help you to integrate Postman within your development toolchain.

You can add new collections, update existing collections, update environments, and add and run monitors directly through the API. This enables you to programmatically access data stored in your Postman account.

You can get started by forking the collection. For more details regarding the Forking navigate to the Postman API.

You will need an API key to access the Postman API.

The Postman API is rate limited.

Fork Postman API

Generating a Postman API key

You need a valid API Key to send requests to the Postman API endpoints.

You can generate an API Key directly from your Postman API Keys page.

Navigate to the Postman API Keys page.

If you do not have any keys yet you will be prompted to create one. Click Generate API Key.

Generate API Key

Enter a name for your key and click Generate API Key.

API Key Name

Copy your key and click Close.

API Key Name

Once you have keys generated you can manage them within your workspace.

Workspace Keys

Use API Key Settings to specify expiration periods for your keys.

API Key Expires

Authentication

You will need to authenticate your requests to the Postman API by sending your API Key in the X-Api-Key header of every request you make.

Your API Key provides access to any Postman data you have permissions for.

You can store your API key in an environment variable—if you name it postman-api-key the Postman API collection will use it automatically

Rate Limits

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. Every API response includes the following set of headers to identify the status of your consumption.

Header Description
X-RateLimit-Limit The maximum number of requests that the consumer is permitted to make per minute.
X-RateLimit-Remaining The number of requests remaining in the current rate limit window.
X-RateLimit-Reset The time at which the current rate limit window resets in UTC epoch seconds.

Free API calls with your Postman account

Your Postman account gives you a limited number of free Postman API calls per month. You can check your usage limits through the Postman API itself or the account usage page.

Next steps

You can combine the Postman API with Newman to integrate Postman with your CI/CD workflow.