How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Postman

Postman api API

The api API from Postman — 16 operation(s) for api.

Documentation Provider Profile APIs.io OpenAPI GitHub

Postman api API is one of 51 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 28 operations across 16 paths, and defines 186 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.

28 operations 16 paths 186 schemas 5 DELETE11 GET6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.getpostman.com
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Postman api API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (PostmanApiKey). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (scimApiKey).

  • scimApiKey — A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/generating-scim-api-key) for calls to SCIM…

Paths & Operations 28

Across 16 paths, the API surfaces 28 operations — 5 DELETE, 11 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

api 28
GET
/apis
Get all APIs
getApis 7 params → 200401403404422500
POST
/apis
Create an API
createApi 3 params body → 200400401403404500
GET
/apis/{apiId}
Get an API
getApi 4 params → 200400401403404422500
PUT
/apis/{apiId}
Update an API
updateApi 3 params body → 200400401403404422500
DELETE
/apis/{apiId}
Delete an API
deleteApi 3 params → 204400401403404422500
POST
/apis/{apiId}/collections
Add a collection
addApiCollection 3 params body → 200400401403404500
GET
/apis/{apiId}/collections/{collectionId}
Get a collection
getApiCollection 5 params → 200400401403404422500
GET
/apis/{apiId}/collections/{collectionId}/comments
Get a collection's comments
getApiCollectionComments 3 params → 200401403404500
POST
/apis/{apiId}/collections/{collectionId}/comments
Create a collection comment
createApiCollectionComment 3 params body → 201401403404500
PUT
/apis/{apiId}/collections/{collectionId}/comments/{commentId}
Update a collection's comment
updateApiCollectionComment 4 params body → 200401403404500
DELETE
/apis/{apiId}/collections/{collectionId}/comments/{commentId}
Delete a collection's comment
deleteApiCollectionComment 4 params → 204401403404500
PUT
/apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks
Sync collection with schema
syncCollectionWithSchema 4 params → 202400401403404422500
GET
/apis/{apiId}/comments
Get an API's comments
getApiComments 2 params → 200400401403404500
POST
/apis/{apiId}/comments
Create an API comment
createApiComment 2 params body → 201400401403404500
PUT
/apis/{apiId}/comments/{commentId}
Update an API's comment
updateApiComment 3 params body → 200400401403404500
DELETE
/apis/{apiId}/comments/{commentId}
Delete an API's comment
deleteApiComment 3 params → 204400401403404500
POST
/apis/{apiId}/schemas
Create a schema
createApiSchema 3 params body → 200400401403404422500
GET
/apis/{apiId}/schemas/{schemaId}
Get a schema
getApiSchema 6 params → 200400401403404422500
GET
/apis/{apiId}/schemas/{schemaId}/files
Get schema files
getApiSchemaFiles 7 params → 200400401403404422500
GET
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
Get schema file contents
getApiSchemaFileContents 6 params → 200400401403404422500
PUT
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
Create or update a schema file
createUpdateApiSchemaFile 5 params body → 200400401403404422500
DELETE
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
Delete a schema file
deleteApiSchemaFile 5 params → 204400401403404422500
GET
/apis/{apiId}/tasks/{taskId}
Get status of an asynchronous task
getStatusOfAnAsyncApiTask 4 params → 200400401403404500
GET
/apis/{apiId}/versions
Get all versions
getApiVersions 5 params → 200401403404422500
POST
/apis/{apiId}/versions
Create a version
createApiVersion 3 params body → 202401403404422500
GET
/apis/{apiId}/versions/{versionId}
Get a version
getApiVersion 4 params → 200400401403404500
PUT
/apis/{apiId}/versions/{versionId}
Update a version
updateApiVersion 4 params body → 200400401403404500
DELETE
/apis/{apiId}/versions/{versionId}
Delete a version
deleteApiVersion 4 params → 204400401403404500

Schemas 186

The contract defines 186 schemas that model the data the API accepts and returns. The most detailed are GetApi1 (12 properties), createUpdateApiSchemaFileResponse (8 properties), updateApiResponse (8 properties), GetApi0 (8 properties). Each schema is shown below with its type and property counts.

GetStatusOfAnAsyncApiTaskRequestInternalServerError
createApiVersionResponse
object
5 properties
CreateApiVersionRequestForbiddenError
GetApiOneOf1CollectionsItems
object
Information about the collection.
1 property
API_createApiVersion_Request
UpdateApiRequestInternalServerError
GetApiSchemaFilesRequestNotFoundError
CreateGitLinkedVersionRootFileCollectionsItems
object
Information about the collection.
1 property
GetStatusOfAnAsyncApiTaskMetaModel
string
The model for which the task is performing the operation.
GetApiVersionRequestForbiddenError
GetStatusOfAnAsyncApiTaskDetailsOneOf0ResourcesItems
object
2 properties
DeleteApiRequestNotFoundError
GetStatusOfAnAsyncApiTaskDetails0
object
Information about the task's resources.
1 property
GetApiVersionsMeta
object
The response's meta information for paginated results.
3 properties
GetApisRequestForbiddenError
GetApiVersionVersionCollectionsItems
object
Information about the collection.
2 properties
CommonErrorErrorObjTypeTitleDetailError
object
Information about the error.
3 properties
commonErrorTypeTitleDetailStatusInstance
object
5 properties
UpdateApiRequestNotFoundError
GetApiOneOf1VersionsItems
object
Information about the version.
2 properties
createGitLinkedVersionRootFile
object
Information about the API version.
5 properties 4 required
cursor
string
CopyCollectionToApiOperationType
string
The COPYCOLLECTION method.
GetApiVersionsRequestInternalServerError
GetApiSchemaFileContentsRequestBadRequestError
apiId
string
CopyCollectionToApiData
object
1 property
CreateGitLinkedVersionSchemasItems
object
Information about the schema.
1 property
commonErrorNameMessage
object
1 property
CreateGitLinkedVersionCollectionsItems
object
Information about the collection.
1 property
GetApiVersionVersionSchemasItems
object
Information about the schema.
2 properties
GetApiCollectionRequestBadRequestError
GetApiSchemaFileContentsRequestInternalServerError
CommonErrorTypeTitleDetailStatusType
AddApiCollectionRequestForbiddenError
GetApiSchemaFileContentsRequestNotFoundError
GetApisMeta
object
The response's meta information for paginated results.
3 properties
GetApiRequestNotFoundError
CreateApiRequestForbiddenError
CreateApiSchemaFilesItems
object
3 properties
GetApisRequestInternalServerError
CreateApiSchemaFilesItemsRoot
object
Information about the schema's root file.
1 property
GetApiVersionRequestInternalServerError
collectionIdApi
string
CreateApiSchemaType
string
The schema's type.
CreateApiSchemaRequestNotFoundError
CreateApiSchemaRequestForbiddenError
CreateUpdateApiSchemaFileRequestBadRequestError
DeleteApiRequestInternalServerError
getApi
SyncCollectionWithSchemaRequestBadRequestError
CommonErrorNameMessageError
object
Information about the error.
2 properties
GetStatusOfAnAsyncApiTaskRequestForbiddenError
GetApiRequestForbiddenError
GenerateApiFromSchemaOperationType
string
The GENERATEFROMSCHEMA method.
getApiVersions
object
2 properties
GetStatusOfAnAsyncApiTaskRequestBadRequestError
API_addApiCollection_Request
DeleteApiSchemaFileRequestBadRequestError
createApiSchema
object
Information about the API schema.
2 properties 2 required
CreateGitLinkedVersionRootFileSchemasItems
object
Information about the schema.
1 property
GetStatusOfAnAsyncApiTaskStatus
string
The task's current status.
SyncCollectionWithSchemaRequestNotFoundError
UpdateApiVersionRequestForbiddenError
syncCollectionWithSchemaResponse
object
1 property
GetApiSchema1
object
Information about the schema.
7 properties
createUpdateApi
object
Information about the API.
3 properties 1 required
GetApisRequestUnauthorizedError
getApis
object
Information about the API schema.
2 properties
CommentCreatedUpdatedData
object
6 properties
CreateApiSchemaRequestInternalServerError
CreateApiVersionRequestNotFoundError
apiInclude
array
GetApiSchemaFilesMeta
object
The schema's non-standard meta information.
1 property
GetApiSchemaRequestBadRequestError
getStatusOfAnAsyncApiTask
object
6 properties
DeleteApiSchemaFileRequestInternalServerError
apiSchemaId
string
GetApiSchemaFilesRequestBadRequestError
GetApiCollectionRequestInternalServerError
CreateApiCollectionOperationType
string
The CREATENEW method.
getApiSchema
commentId
integer
commentCreatedUpdated
object
1 property
getApiVersion
object
1 property
GetApiSchemaFileContentsRequestForbiddenError
getApiSchemaFiles
object
2 properties
CreateApiCollectionDataInfoSchema
string
The collection's schema format.
v10Accept
string
CreateApiRequestInternalServerError
CreateGitUnlinkedVersionSchemaSchemasItems
object
Information about the schema.
1 property
apiDescription
string
commentCreate
object
Information about the comment.
3 properties 1 required
getApiSchemaFileContents
object
8 properties
GetApisRequestNotFoundError
CreateUpdateApiSchemaFileRequestForbiddenError
CreateApiCollectionDataInfo
object
Information about the collection.
2 properties
SyncCollectionWithSchemaRequestForbiddenError
GetApiSchemaFilesRequestInternalServerError
createGitLinkedVersion
object
Information about the API version.
5 properties 4 required
GetApi1
object
The API's extended data schema. Note: Git-connected APIs will only return the versions and gitInfo query responses. This is because schema and collection infor…
12 properties
commentData
object
Information about the comment.
7 properties
createApiSchemaResponse
object
Information about the API schema.
7 properties
GetApiSchemaRequestInternalServerError
GetApiVersionsRequestForbiddenError
updateApiResponse
object
8 properties 1 required
GetStatusOfAnAsyncApiTaskDetails
commonErrorTypeTitleDetailStatus
object
4 properties
createApiResponse
object
8 properties
DeleteApiVersionRequestBadRequestError
commentTaggedUsers
object
Information about users tagged in the body comment.
1 property
workspaceId
string
addApiCollectionResponse
object
1 property
GetApiCollectionRequestForbiddenError
GetApiVersionsRequestNotFoundError
DeleteApiVersionRequestNotFoundError
file-path
string
GetStatusOfAnAsyncApiTaskMeta
object
The response's non-standard meta information.
3 properties
CreateUpdateApiSchemaFileResponseRoot
object
Information about the schema's root file.
1 property
GetStatusOfAnAsyncApiTaskMetaAction
string
The task's action.
GetApi0
object
8 properties
UpdateApiVersionRequestInternalServerError
commentUpdate
object
Information about the comment.
2 properties 1 required
CreateApiCollectionData
object
Information about the collection's contents, such as requests and responses. For a complete list of values, refer to the [Postman Collection Format documentati…
2 properties
CreateApiSchemaResponseFilesItems
object
Information about the schema file.
8 properties
DeleteApiRequestForbiddenError
GetStatusOfAnAsyncApiTaskDetailsOneOf1Error
object
1 property
UpdateApiRequestForbiddenError
UpdateApiVersionRequestNotFoundError
GetApiVersionsVersionsItems
object
Information about the API version.
5 properties
CreateUpdateApiSchemaFileRequestInternalServerError
GetApiSchemaRequestNotFoundError
createGitUnlinkedVersionSchema
object
Information about the API version.
4 properties 3 required
CreateApiSchemaRequestBadRequestError
apiSchemaOutput
boolean
DeleteApiVersionRequestForbiddenError
GetApiRequestInternalServerError
CreateApiVersionRequestInternalServerError
GetApiCollectionInfo
object
Information about the collection.
4 properties
DeleteApiVersionRequestInternalServerError
apiVersionId
string
CommentDataStatus
string
The comment's current status.
GetApisApisItems
object
The API's base data schema.
8 properties
CreateGitUnlinkedVersionSchemaCollectionsItems
object
Information about the collection.
1 property
commonErrorTypeTitleDetail
object
3 properties
createUpdateApiSchemaFileResponse
object
Information about the schema file.
8 properties
createApiCollection
object
2 properties
GetApiSchema0
object
Information about the schema.
7 properties
getApiCollection
object
4 properties
CommonErrorTypeTitleDetailDetail
Information about the error.
commonErrorErrorObjTypeTitleDetail
object
1 property
AddApiCollectionRequestInternalServerError
CreateUpdateApiSchemaFileRequestNotFoundError
createUpdateApiSchemaFile
object
Information about schema file.
3 properties
CreateApiSchemaResponseFilesItemsRoot
object
An object that contains root file information.
1 property
CreateUpdateApiSchemaFileRoot
object
Information about the schema's root file.
1 property
GetApiSchemaFilesFilesItems
object
Information about the schema file.
7 properties
copyCollectionToApi
object
2 properties
createdBy
integer
GetApiVersionRequestNotFoundError
CommentTaggedUsersUserNameType
string
The user value.
GetApiVersionVersion
object
Information about the API version.
7 properties
GetStatusOfAnAsyncApiTaskDetails1
object
Information about the error that occurred during the task's processing.
1 property
GetApiSchemaRequestForbiddenError
commonErrorTypeTitleMessageDetail
object
4 properties
apiErrorNameMessage
object
2 properties
CreateApiSchemaResponseType
string
The schema's type.
updateApiVersion
object
Information about the API version.
2 properties 1 required
GetApiSchemaFilesRequestForbiddenError
CommentTaggedUsersUserName
object
An object that contains information about the tagged user. The object's name is the user's Postman username. For example, @user-postman.
2 properties 2 required
GetApiOneOf1GitInfo
object
Information about the API's Git repository integration.
5 properties
GetApiOneOf1SchemasItems
object
Information about the schema.
1 property
DeleteApiSchemaFileRequestForbiddenError
ApiIncludeItems
string
GetApiSchemaOneOf0Files
object
Information about the schema's files. The response is paginated and limited to one page.
2 properties
GetApiSchemaOneOf0FilesDataItems
object
Information about the schema file.
7 properties
updateApiVersionResponse
object
Information about the API version.
5 properties
GetApiSchemaOneOf0FilesMeta
object
The response's non-standard meta information.
1 property
SyncCollectionWithSchemaRequestInternalServerError
apiTaskId
string
commentResponse
object
1 property
GetApiCollectionRequestNotFoundError
DeleteApiSchemaFileRequestNotFoundError
generateApiFromSchema
object
3 properties
limit
integer
AddApiCollectionRequestNotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-api-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

Postman
AE Profile APIs.io
Postman Collections API
AE Profile APIs.io
Postman Workspaces API
AE Profile APIs.io
Postman Environments API
AE Profile APIs.io
Postman Monitors API
AE Profile APIs.io
Postman Webhooks API
AE Profile APIs.io
Postman Tags API
AE Profile APIs.io
Postman Billing API
AE Profile APIs.io
Postman SCIM API
AE Profile APIs.io
Postman MCP Server
AE Profile APIs.io
Postman Flows
AE Profile APIs.io
Postman Mocks API
AE Profile APIs.io
← Back to P APIs
API Details
ID
postman:postman-api-api
Base URL
https://api.getpostman.com
Docs
https://www.postman.com/
Provider
Postman
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=postman-api-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/postman-api-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Postman api API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.