Postman API - Postman | Specway Docs

Own Postman? Customize your docs with AI search, analytics, and more.

Claim your docs

Postman

Powered by Specway

Own Postman? Customize your docs with AI search, analytics, and more.

Claim your docs

Postman

Powered by Specway

Endpoints

Create APIPOST
Create API VersionPOST
Create collection from schemaPOST
Create relationsPOST
Create SchemaPOST
Delete an APIDELETE
Delete an API VersionDELETE
Get documentation relationsGET
Get All API VersionsGET
Get all APIsGET
Get an API VersionGET
Get contract test relationsGET
Get environment relationsGET
Get integration test relationsGET
Get linked relationsGET
Get monitor relationsGET
Get SchemaGET
Get test suite relationsGET
Single APIGET
Sync relations with schemaPUT
Update an APIPUT
Update an API VersionPUT
Update SchemaPUT

All CollectionsGET
Create a ForkPOST
Create CollectionPOST
Delete CollectionDELETE
Merge a ForkPOST
Single Collection GET
Update CollectionPUT

All EnvironmentsGET
Create EnvironmentPOST
Delete EnvironmentDELETE
Single EnvironmentGET
Update EnvironmentPUT

Import exported dataPOST
Import external API specificationPOST

API Key OwnerGET

All MocksGET
Create MockPOST
Delete MockDELETE
Publish MockPOST
Single MockGET
Unpublish MockDELETE
Update MockPUT

All MonitorsGET
Create MonitorPOST
Delete MonitorDELETE
Run a MonitorPOST
Single MonitorGET
Update MonitorPUT

Create WebhookPOST

All workspacesGET
Create WorkspacePOST
Delete WorkspaceDELETE
Single workspaceGET
Update WorkspacePUT

Endpoints

Create APIPOST
Create API VersionPOST
Create collection from schemaPOST
Create relationsPOST
Create SchemaPOST
Delete an APIDELETE
Delete an API VersionDELETE
Get documentation relationsGET
Get All API VersionsGET
Get all APIsGET
Get an API VersionGET
Get contract test relationsGET
Get environment relationsGET
Get integration test relationsGET
Get linked relationsGET
Get monitor relationsGET
Get SchemaGET
Get test suite relationsGET
Single APIGET
Sync relations with schemaPUT
Update an APIPUT
Update an API VersionPUT
Update SchemaPUT

All CollectionsGET
Create a ForkPOST
Create CollectionPOST
Delete CollectionDELETE
Merge a ForkPOST
Single Collection GET
Update CollectionPUT

All EnvironmentsGET
Create EnvironmentPOST
Delete EnvironmentDELETE
Single EnvironmentGET
Update EnvironmentPUT

Import exported dataPOST
Import external API specificationPOST

API Key OwnerGET

All MocksGET
Create MockPOST
Delete MockDELETE
Publish MockPOST
Single MockGET
Unpublish MockDELETE
Update MockPUT

All MonitorsGET
Create MonitorPOST
Delete MonitorDELETE
Run a MonitorPOST
Single MonitorGET
Update MonitorPUT

Create WebhookPOST

All workspacesGET
Create WorkspacePOST
Delete WorkspaceDELETE
Single workspaceGET
Update WorkspacePUT

Postman API

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 <a href="#authentication">API Key</a> to send requests to the API endpoints. You can get your key from the [integrations dashboard](https://go.postman.co/settings/me/api-keys). 1. The API has an access <a href="#rate-limits">rate limit</a> applied to it. 1. The Postman API will only respond to secured communication done over HTTPS. HTTP requests will be sent a `301` redirect to corresponding HTTPS resources. 1. Response to every request is sent in [JSON format](https://en.wikipedia.org/wiki/JSON). In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response. 1. The request method (verb) determines the nature of action you intend to perform. A request mad

Base URL

https://api.getpostman.com

Endpoints

57 endpoints available

API Key Owner

Get all APIs

Create API

All Mocks

Create Mock

All Monitors

Create Monitor

Create Webhook

All workspaces

Create Workspace

All Collections

Create Collection

/apis/{apiId}

Single API

/apis/{apiId}

Update an API

/apis/{apiId}

Delete an API

/environments

All Environments

/environments

Create Environment

/import/openapi

Import external API specification

/import/exported

Import exported data

/mocks/{mock_uid}

Single Mock

/mocks/{mock_uid}

Update Mock

/mocks/{mock_uid}

Delete Mock

/collections/merge

Merge a Fork

/apis/{apiId}/versions

Get All API Versions

/apis/{apiId}/versions

Create API Version

/monitors/{monitor_uid}

Single Monitor

/monitors/{monitor_uid}

Update Monitor

/monitors/{monitor_uid}

Delete Monitor

/mocks/{mock_uid}/publish

Publish Mock

/workspaces/{workspace_id}

Single workspace

/workspaces/{workspace_id}

Update Workspace

/workspaces/{workspace_id}

Delete Workspace

/mocks/{mock_uid}/unpublish

Unpublish Mock

/monitors/{monitor_uid}/run

Run a Monitor

/collections/{collection_uid}

Single Collection

/collections/{collection_uid}

Update Collection

/collections/{collection_uid}

Delete Collection

/environments/{environment_uid}

Single Environment

/environments/{environment_uid}

Update Environment

/environments/{environment_uid}

Delete Environment

/collections/fork/{collection_uid}

Create a Fork

/apis/{apiId}/versions/{apiVersionId}

Get an API Version

/apis/{apiId}/versions/{apiVersionId}

Update an API Version

/apis/{apiId}/versions/{apiVersionId}

Delete an API Version

/apis/{apiId}/versions/{apiVersionId}/monitor

Get monitor relations

/apis/{apiId}/versions/{apiVersionId}/schemas

Create Schema

/apis/{apiId}/versions/{apiVersionId}/relations

Get linked relations

/apis/{apiId}/versions/{apiVersionId}/relations

Create relations

/apis/{apiId}/versions/{apiVersionId}/testsuite

Get test suite relations

/apis/{apiId}/versions/{apiVersionId}/environment

Get environment relations

/apis/{apiId}/versions/{apiVersionId}/contracttest

Get contract test relations

/apis/{apiId}/versions/{apiVersionId}/documentation

Get documentation relations

/apis/{apiId}/versions/{apiVersionId}/integrationtest

Get integration test relations

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}

Get Schema

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}

Update Schema

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections

Create collection from schema

/apis/{apiId}/versions/{apiVersionId}/{entityType}/{entityId}/syncWithSchema

Sync relations with schema

Postman API

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 <a href="#authentication">API Key</a> to send requests to the API endpoints. You can get your key from the [integrations dashboard](https://go.postman.co/settings/me/api-keys). 1. The API has an access <a href="#rate-limits">rate limit</a> applied to it. 1. The Postman API will only respond to secured communication done over HTTPS. HTTP requests will be sent a `301` redirect to corresponding HTTPS resources. 1. Response to every request is sent in [JSON format](https://en.wikipedia.org/wiki/JSON). In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response. 1. The request method (verb) determines the nature of action you intend to perform. A request mad

Base URL

https://api.getpostman.com

Endpoints

57 endpoints available

API Key Owner

Get all APIs

Create API

All Mocks

Create Mock

All Monitors

Create Monitor

Create Webhook

All workspaces

Create Workspace

All Collections

Create Collection

/apis/{apiId}

Single API

/apis/{apiId}

Update an API

/apis/{apiId}

Delete an API

/environments

All Environments

/environments

Create Environment

/import/openapi

Import external API specification

/import/exported

Import exported data

/mocks/{mock_uid}

Single Mock

/mocks/{mock_uid}

Update Mock

/mocks/{mock_uid}

Delete Mock

/collections/merge

Merge a Fork

/apis/{apiId}/versions

Get All API Versions

/apis/{apiId}/versions

Create API Version

/monitors/{monitor_uid}

Single Monitor

/monitors/{monitor_uid}

Update Monitor

/monitors/{monitor_uid}

Delete Monitor

/mocks/{mock_uid}/publish

Publish Mock

/workspaces/{workspace_id}

Single workspace

/workspaces/{workspace_id}

Update Workspace

/workspaces/{workspace_id}

Delete Workspace

/mocks/{mock_uid}/unpublish

Unpublish Mock

/monitors/{monitor_uid}/run

Run a Monitor

/collections/{collection_uid}

Single Collection

/collections/{collection_uid}

Update Collection

/collections/{collection_uid}

Delete Collection

/environments/{environment_uid}

Single Environment

/environments/{environment_uid}

Update Environment

/environments/{environment_uid}

Delete Environment

/collections/fork/{collection_uid}

Create a Fork

/apis/{apiId}/versions/{apiVersionId}

Get an API Version

/apis/{apiId}/versions/{apiVersionId}

Update an API Version

/apis/{apiId}/versions/{apiVersionId}

Delete an API Version

/apis/{apiId}/versions/{apiVersionId}/monitor

Get monitor relations

/apis/{apiId}/versions/{apiVersionId}/schemas

Create Schema

/apis/{apiId}/versions/{apiVersionId}/relations

Get linked relations

/apis/{apiId}/versions/{apiVersionId}/relations

Create relations

/apis/{apiId}/versions/{apiVersionId}/testsuite

Get test suite relations

/apis/{apiId}/versions/{apiVersionId}/environment

Get environment relations

/apis/{apiId}/versions/{apiVersionId}/contracttest

Get contract test relations

/apis/{apiId}/versions/{apiVersionId}/documentation

Get documentation relations

/apis/{apiId}/versions/{apiVersionId}/integrationtest

Get integration test relations

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}

Get Schema

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}

Update Schema

/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections

Create collection from schema

/apis/{apiId}/versions/{apiVersionId}/{entityType}/{entityId}/syncWithSchema

Sync relations with schema