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 specs API

The specs API from Postman — 14 operation(s) for specs.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Specs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 14 paths, and defines 157 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.

24 operations 14 paths 157 schemas 2 DELETE11 GET3 PATCH6 POST2 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 specs 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 24

Across 14 paths, the API surfaces 24 operations — 2 DELETE, 11 GET, 3 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

specs 24
GET
/apis/{apiId}/spec-migrations
Get status of API Builder to Spec Hub migration
getMigrationStatus 3 params → 200400401403500
POST
/apis/{apiId}/spec-migrations
Migrate API Builder API to Spec Hub
migrateApiToSpecHub 3 params body → 200400401403500
GET
/collections/{collectionUid}/generations/{elementType}
Get generated spec
getGeneratedCollectionSpecs 3 params → 200403404500
POST
/collections/{collectionUid}/generations/{elementType}
Generate spec from collection
generateSpecFromCollection 3 params body → 200403404423500
PUT
/collections/{collectionUid}/synchronizations
Sync collection with spec
syncCollectionWithSpec 3 params → 202403404500
GET
/{elementType}/{elementId}/tasks/{taskId}
Get status of an async spec task
getAsyncSpecTaskStatus 4 params → 200401403404500
GET
/specs
Get all specs
getAllSpecs 4 params → 200400401403500
POST
/specs
Create a spec
createSpec 2 params body → 201400401403404500
GET
/specs/{specId}
Get a spec
getSpec 2 params → 200401403404500
DELETE
/specs/{specId}
Delete a spec
deleteSpec 2 params → 204401403404500
PATCH
/specs/{specId}
Update a spec's properties
updateSpecProperties 2 params body → 200400401403404500
PATCH
/specs/{specId}/collections/{collectionId}/sync-options
Update spec sync options
updateSpecSyncOptions 3 params body → 200400401403404500
GET
/specs/{specId}/definitions
Get a spec's definition
getSpecDefinition 2 params → 200400401403404500
GET
/specs/{specId}/files
Get a spec's files
getSpecFiles 2 params → 200401403404500
POST
/specs/{specId}/files
Create a spec file
createSpecFile 2 params body → 201400401403404500
GET
/specs/{specId}/files/{filePath}
Get a spec file
getSpecFile 3 params → 200400401403404500
DELETE
/specs/{specId}/files/{filePath}
Delete a spec file
deleteSpecFile 3 params → 204400401403404500
PATCH
/specs/{specId}/files/{filePath}
Update a spec file
updateSpecFile 3 params body → 200400401403404500
GET
/specs/{specId}/generations/{elementType}
Get a spec's generated collections
getSpecCollections 5 params → 200401403404500
POST
/specs/{specId}/generations/{elementType}
Generate a collection from spec
generateCollection 3 params body → 202401403404423500
PUT
/specs/{specId}/synchronizations
Sync spec with collection
syncSpecWithCollection 3 params → 202401403404500
GET
/specs/{specId}/version-tags/{tagId}/files
Get a version tag
getSpecVersionTag 3 params → 200401403404500
GET
/specs/{specId}/version-tags
Get a specification's version tags
getSpecVersionTags 4 params → 200401403404500
POST
/specs/{specId}/version-tags
Create a version tag
createSpecVersionTag 2 params body → 201400401403404409500

Schemas 157

The contract defines 157 schemas that model the data the API accepts and returns. The most detailed are GetSpecVersionTagDataItems (11 properties), generateCollectionOptions (10 properties), getSpecFile (9 properties), specFileData (8 properties). Each schema is shown below with its type and property counts.

createSpecFile
object
2 properties 2 required
GetAsyncTaskStatusMetaModel
string
The model for which the task is performing the operation.
GetMigrationStatus400ErrorError
object
3 properties
GetSpecDefinitionRequestForbiddenError
collectionUid
string
getGeneratedCollectionSpecs
object
2 properties
GetSpecRequestForbiddenError
generateCollection
object
2 properties 2 required
MigrateApiToSpecHub400ErrorTitleMessageError
object
2 properties
CreateSpecFilesItems0
object
3 properties 3 required
GetSpecFileRequestInternalServerError
migrateGitConnectedApiToSpecHub
object
2 properties 2 required
GetSpecFilesRequestForbiddenError
collectionId
string
commonErrorTypeTitleDetailStatusInstance
object
5 properties
GetGeneratedCollectionSpecsRequestForbiddenError
apiSpecSyncOptions
object
1 property
DeleteSpecFileRequestForbiddenError
specData
object
Information about the API specification.
8 properties
cursor
string
apiId
string
UpdateSpecFileRequestForbiddenError
GeneratedSpecCollectionDataState
string
The sync state of the collection and its API specification.
SyncCollectionWithSpecRequestInternalServerError
GetGeneratedCollectionSpecsRequestInternalServerError
specCollectionData
object
Information about the API specification's collection.
6 properties
commonErrorNameMessage
object
1 property
getMigrationStatus400Error
object
1 property
migrateApiToSpecHub400ErrorTitleMessageDetails
object
1 property
CommonErrorTypeTitleDetailStatusType
GetSpecVersionTagDataItemsType
string
The file's type.
GenerateCollectionOptionsIndentCharacter
string
The option for setting the indentation character type.
generateSpecFromCollection
object
3 properties 1 required
DeleteSpecFileRequestInternalServerError
GetMigrationStatusDetails1
object
Information about the migration.
1 property
taskId
string
elementType
string
Specs_getAsyncSpecTaskStatus_Response_200
SyncSpecWithCollectionRequestForbiddenError
fileFormat
string
The specification's file format.
generateCollectionOptions
object
The advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.…
10 properties
UpdateSpecPropertiesRequestForbiddenError
UpdateSpecSyncOptionsRequestInternalServerError
getSpecFile
object
Information about the API specification file.
9 properties
GetAsyncTaskStatusStatus
string
The task's current status.
CommonErrorNameMessageError
object
Information about the error.
2 properties
UpdateSpecSyncOptionsRequestForbiddenError
GenerateSpecFromCollectionFormat
string
The format of the API specification.
createSpecVersionTag
object
1 property 1 required
GetSpecDefinitionRequestInternalServerError
DeleteSpecRequestInternalServerError
GetSpecVersionTagsDataItems
object
Information about the version tag.
2 properties
CreateSpecVersionTagRequestForbiddenError
meta
object
1 property
specId
string
migrateApiToSpecHub400ErrorTypeNameMessageTitle
object
1 property
GetSpecVersionTagRequestForbiddenError
UpdateSpecFileRequestInternalServerError
MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails
object
Information about the error.
1 property
GetSpecCollectionsRequestInternalServerError
GetMigrationStatusRequestInternalServerError
GetSpecCollectionsRequestForbiddenError
v10Accept
string
createUpdateSpecFileResponse
object
Information about the API specification file.
7 properties
MigrateApiToSpecHubRequestForbiddenError
MigrateApiToSpecHubRequestInternalServerError
GetAsyncTaskStatusFailedStatus
string
The task's current status.
GetSpecVersionTagDataItemsFileType
string
The type of file: - ROOT — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (DEFAULT) spec…
getSpecVersionTags
object
2 properties
migrateApiToSpecHubNewWorkspace
object
1 property 1 required
GetAsyncSpecTaskStatusRequestForbiddenError
GetAsyncTaskStatusMeta
object
The response's non-standard meta information.
2 properties
createSpecResponse
object
7 properties
generateTaskResponse
object
2 properties
CreateSpecVersionTagResponseData
object
Information about the created version tag.
2 properties
GetSpecVersionTagDataItems
object
Information about the element.
11 properties
CreateSpecFilesItems
Specs_getSpecDefinition_Response_200
object
Empty response body
GetSpecVersionTagsRequestForbiddenError
CreateUpdateSpecFileResponseType
string
The type of file: - ROOT — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (DEFAULT) spec…
GetAllSpecsRequestInternalServerError
elementTypeSpec
string
filePath
string
migrateToSpecHubResponse
object
2 properties
asyncSpecTaskStatus
object
Information about the task's resources.
1 property
commonErrorTypeTitleDetailStatus
object
4 properties
GetSpecVersionTagRequestInternalServerError
MigrateApiToSpecHubNewWorkspaceWorkspaceInfo
object
Information about the new workspace.
1 property 1 required
GetAsyncTaskStatusFailedMetaModel
string
The model for which the task is performing the operation.
ApiSpecSyncOptionsSyncOptions
object
Information about the specification sync options.
2 properties
GenerateSpecFromCollectionType
string
The specification's type.
getMigrationStatus
object
2 properties
workspaceId
string
MigrateGitConnectedApiToSpecHubGitInfo
object
Information about the connected remote Git mono-repo.
1 property 1 required
migrateApiToSpecHub400ErrorTitleMessage
object
1 property
migrateApiToSpecHubExistingWorkspace
object
1 property 1 required
GetSpecRequestInternalServerError
GenerateSpecFromCollectionRequestInternalServerError
GetAllSpecsSpecsItems
object
Information about the API specification.
7 properties
getMigrationStatusDetails
specType
string
The type of API specification.
GetSpecFileRequestForbiddenError
CreateSpecRequestForbiddenError
generatedSpecCollectionData
object
Information about the collection's API specification.
7 properties
GenerateCollectionRequestInternalServerError
CreateSpecFilesItemsOneOf0Type
string
The type of file. This property is required when creating multi-file specifications: - ROOT — The file containing the full OpenAPI structure. This serves as th…
MigrateApiToSpecHub400ErrorTypeNameMessageTitleError
object
4 properties
UpdateSpecFileType
string
The type of file: - ROOT — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (DEFAULT) spec…
AsyncSpecTaskStatusResourcesItems
object
2 properties
CreateSpecFileRequestInternalServerError
GetSpecFilesRequestInternalServerError
createSpec
object
3 properties 3 required
UpdateSpecPropertiesRequestInternalServerError
SyncCollectionWithSpecRequestForbiddenError
SpecFileDataType
string
The type of file: - ROOT — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - DEFAULT — A file referenced by the ROOT fi…
CreateSpecRequestInternalServerError
commonErrorTypeTitleDetail
object
3 properties
GetMigrationStatusRequestForbiddenError
CreateSpecFilesItems1
object
2 properties 2 required
GetAsyncTaskStatusFailedMeta
object
The response's non-standard meta information.
2 properties
GenerateCollectionOptionsRequestNameSource
string
Determines how the generated collection's requests are named. If the Fallback value is passed, then the request is named after one of the following values in t…
GenerateCollectionOptionsFolderStrategy
string
Whether to create folders based on the specification's paths or tags properties.
elementId
specFileData
object
Information about the API specification file.
8 properties
GetMigrationStatusDetails0
object
Information about the migration.
1 property
CommonErrorTypeTitleDetailDetail
Information about the error.
GenerateSpecFromCollectionRequestForbiddenError
GetSpecFileType
string
The type of file: - ROOT — A file containing the full OpenAPI structure and references other (DEFAULT) spec files. - DEFAULT — A file referenced by the ROOT fi…
getAsyncTaskStatus
object
3 properties
tagId
string
updateSpecFile
object
You must pass one of the accepted values in this request body. Also, this request body does not accept multiple properties in a single call. For example, you c…
3 properties
SpecCollectionDataState
string
The sync state of the collection and its API specification.
commonErrorTypeTitleMessageDetail
object
4 properties
CreateSpecVersionTagRequestInternalServerError
getSpecVersionTag
object
1 property
CreateSpecFileRequestForbiddenError
GetSpecVersionTagsRequestInternalServerError
GenerateCollectionRequestForbiddenError
GetAsyncSpecTaskStatusRequestInternalServerError
getSpecFiles
object
Information about the specification's files.
2 properties
updateSpecPropertiesResponse
object
7 properties
MigrateApiToSpecHub400ErrorTitleMessageDetailsError
object
3 properties
GetAllSpecsRequestForbiddenError
getSpecCollections
object
2 properties
elementTypeCollection
string
DeleteSpecRequestForbiddenError
getAllSpecs
object
2 properties
migrateApiToSpecHub
metaData
object
The response's meta information for paginated results.
1 property
GetMigrationStatusStatus
string
The status of the migration.
getAsyncTaskStatusFailed
object
3 properties
createSpecVersionTagResponse
object
1 property
SyncSpecWithCollectionRequestInternalServerError
limit
integer
MigrateGitConnectedApiToSpecHubWorkspaceInfo
object
Information about the new workspace.
1 property 1 required
MigrateApiToSpecHubRequestBadRequestError
updateSpecProperties
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-specs-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
#Specs
← Back to P APIs
API Details
ID
postman:postman-specs-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-specs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/postman-specs-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 specs 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.