Integrate with "Postman API" from getpostman.com in no time with Mockoon's ready to use mock sample
getpostman.com
Version: 1.20.0
Integrate third-party APIs faster by using "Postman API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
Improve your integration tests by mocking third-party APIs and cover more edge cases: slow response time, random failures, etc.
The Postman API allows you to programmatically access data stored in Postman account with ease.
The easiest way to get started with the API is to click the fork button to fork this collection to your own workspace and use Postman to send requests.
Overview
You need a valid API Key to send requests to the API endpoints. You can get your key from the integrations dashboard.
The API has an access rate limit applied to it.
The Postman API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.
Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an "error": {} key in the JSON response.
The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Postman, and POST implies you want to save something new to Postman.
The API calls will respond with appropriate HTTP status codes for all requests. Within Postman Client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively.
Individual resources in your Postman Account is accessible using its unique id (uid). The uid is a simple concatenation of the resource owner's user-id and the resource-id. For example, a collection's uid is {{ownerid}}-{{collectionid}}.
Authentication
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.
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 postmanapikey and this Collection will automatically use it to make API calls.
API Key related error response
If an API Key is missing, malformed, or invalid, you will receive a 401 Unauthorised response code and the following JSON response:
Support
For help regarding accessing the Postman API, feel free to discuss it in our Discourse Community. You can also drop in a line at [email protected].
In the event you receive a 503 response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 5 minutes. If the outage persists, or your receive any other form of 5XX error, kindly let us know.
Terms of Use
For information on API terms of use and privacy, refer to our terms at http://postman.com/legal/terms/ and our privacy policy at https://www.postman.com/legal/privacy-policy/.
API Reference