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 1. You need a valid API Key to se
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.getpostman.com
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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 1. You need a valid API Key to send requests to the API endpoints. You can get your key from the [integrations dashboard](https://go.
| method | path | what the vendor says it does |
|---|---|---|
GET | /apis | Get all APIs This call fetches all the APIs present in the specified workspace Response contains an array nam |
POST | /apis | Create API This call creates a new API with a default API Version. Request body should contain an `api` obj |
GET | /apis/{apiId} | Single API This call fetches a single API having the specified id. Response contains an `api` object with all |
PUT | /apis/{apiId} | Update an API This call updates an existing API . Request body should contain an `api` object which should |
DELETE | /apis/{apiId} | Delete an API This call deletes an existing API having the specified id. Response contains an `api` object |
GET | /apis/{apiId}/versions | Get All API Versions This call fetches details about the all the API Versions in the specified API. The respo |
POST | /apis/{apiId}/versions | Create API Version This call creates a new API version in the specified API. Request body should contain a |
GET | /apis/{apiId}/versions/{apiVersionId} | Get an API Version This call fetches details about the specified API Version. The response will contain a `ve |
PUT | /apis/{apiId}/versions/{apiVersionId} | Update an API Version This call updates an existing API Version. Request body should contain a `version` ob |
DELETE | /apis/{apiId}/versions/{apiVersionId} | Delete an API Version This call deletes an existing API Version having the specified id. Response contains |
GET | /apis/{apiId}/versions/{apiVersionId}/contracttest | Get contract test relations This call fetches all the relations by type which are linked to the specified API |
GET | /apis/{apiId}/versions/{apiVersionId}/documentation | Get documentation relations This call fetches all the relations by type which are linked to the specified API |
GET | /apis/{apiId}/versions/{apiVersionId}/environment | Get environment relations This call fetches all the relations by type which are linked to the specified API ve |
GET | /apis/{apiId}/versions/{apiVersionId}/integrationtest | Get integration test relations This call fetches all the relations by type which are linked to the specified A |
GET | /apis/{apiId}/versions/{apiVersionId}/monitor | Get monitor relations This call fetches all the relations by type which are linked to the specified API versio |
GET | /apis/{apiId}/versions/{apiVersionId}/relations | Get linked relations This call fetches all the relations which are linked to the specified API version along w |
POST | /apis/{apiId}/versions/{apiVersionId}/relations | Create relations This call allows you to add existing Postman entities as new relations to an API. The request |
POST | /apis/{apiId}/versions/{apiVersionId}/schemas | Create Schema This call creates a new schema. Request body should contain a `schema` object which should atle |
GET | /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId} | Get Schema This call fetches a single schema having the specified id. Response contains a `schema` object wit |
PUT | /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId} | Update Schema This call updates an existing schema. Request body should contain a `schema` object which shoul |
POST | /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections | Create collection from schema This call creates a collection and links it to an API as one or multiple relatio |
GET | /apis/{apiId}/versions/{apiVersionId}/testsuite | Get test suite relations This call fetches all the relations by type which are linked to the specified API ver |
PUT | /apis/{apiId}/versions/{apiVersionId}/{entityType}/{entityId}/syncWithSchema | Sync relations with schema This call allows you to keep the relation in sync with the API schema. > Requires |
GET | /collections | All Collections The `/collections` endpoint returns a list of all [collections](https://www.getpostman.com/doc |
POST | /collections | Create Collection This endpoint allows you to create collections using the Postman Collection v2 format. For m |
POST | /collections/fork/{collection_uid} | Create a Fork This endpoint allows you to create a fork from an existing collection. On successful creation o |
POST | /collections/merge | Merge a Fork This endpoint allows you to merge a forked collection back to its destination collection. On suc |
GET | /collections/{collection_uid} | Single Collection Access the contents of a collection that is accessible to you using its unique id (`uid`). |
PUT | /collections/{collection_uid} | Update Collection This endpoint allows you to update an existing collection using the Postman Collection v2 fo |
DELETE | /collections/{collection_uid} | Delete Collection This endpoint allows you to delete an existing collection. On successful deletion of the co |
GET | /environments | All Environments The `/environments` endpoint returns a list of all [environments](https://www.getpostman.com/ |
POST | /environments | Create Environment A sample body is added to the request that conforms to the following JSON schema: ```json |
GET | /environments/{environment_uid} | Single Environment Access the contents of an environment that is accessible to you using its unique id (`uid`) |
PUT | /environments/{environment_uid} | Update Environment This endpoint replaces an existing environment. A sample body is added to the request that |
DELETE | /environments/{environment_uid} | Delete Environment This endpoint allows you to delete a single environment based on an environment's unique `u |
POST | /import/exported | Import exported data This endpoint allows you to import your exported Postman data. For more information about |
POST | /import/openapi | Import external API specification This endpoint allows you to import external API specifications into Postman. |
GET | /me | API Key Owner the `/me` Postman API endpoint lets you access information about the authenticated user. You can |
GET | /mocks | All Mocks This endpoint fetches all the mocks that you have created. > Requires API Key as `X-Api-Key` reques |
POST | /mocks | Create Mock This endpoint allows you to create a mock on a collection. You can also provide an environment UID |
and 17 more operation(s) in this specification, all searchable.
specification origin: https://gist.githubusercontent.com/MikeRalphson/f5dd7e7e712a4f2caa8f1783f1053dbc/raw/05fb7
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.