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

The components API from Postman — 5 operation(s) for components.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 9 operations across 5 paths, and defines 59 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.

9 operations 5 paths 59 schemas 5 GET2 PATCH2 POST

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 components 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 9

Across 5 paths, the API surfaces 9 operations — 5 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

components 9
GET
/components
Get all components
getAllComponents 6 params → 200400401500
POST
/components
Create a component
createComponent 1 param body → 201400401403409500
GET
/components/{componentId}
Get a component
getComponent 4 params → 200400401403404500
PATCH
/components/{componentId}
Update a component
updateComponent 2 params body → 200400401403404409500
GET
/components/{componentId}/drafts
Get a component draft
getComponentDraft 2 params → 200400401403404500
PATCH
/components/{componentId}/drafts
Update a component draft
updateComponentDraft 2 params body → 200400401403404409500
GET
/components/{componentId}/versions
Get all component versions
getComponentVersions 3 params → 200400401403404500
POST
/components/{componentId}/versions
Create a component version
createComponentVersion 2 params body → 201400401403404409500
GET
/components/{componentId}/versions/{versionId}
Get a component version
getComponentVersion 4 params → 200400401403404500

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are componentData (10 properties), componentVersionData (6 properties), commonErrorTypeTitleDetailStatus (4 properties), createComponent (4 properties). Each schema is shown below with its type and property counts.

CreateComponentRequestForbiddenError
ComponentDataLatestVersion
Information about the component's latest version. This property only returns only when you pass the latestVersion value for the include parameter. To return de…
createComponentVersionResponse
object
Information about the component version.
1 property
CreateComponentVersionRequestForbiddenError
UpdateComponentDraftRequestForbiddenError
GetComponentDraftRequestForbiddenError
GetComponentRequestUnauthorizedError
UpdateComponentDraftRequestUnauthorizedError
CommonErrorNameMessageError
object
Information about the error.
2 properties
componentType
string
The component's type. Corresponds to the specification that the component's content adheres to.
commonErrorTypeTitleDetail
object
3 properties
getAllComponents
object
2 properties
updateComponent
createComponentVersion
object
2 properties 1 required
UpdateComponentRequestUnauthorizedError
GetComponentVersionRequestForbiddenError
GetComponentDraftRequestUnauthorizedError
CreateComponentVersionSource
object
The source to publish the version from. Defaults to the component's current draft.
1 property
componentIncludeFields
string
commonErrorTypeTitleDetailStatus
object
4 properties
CreateComponentRequestInternalServerError
CommonErrorTypeTitleDetailDetail
Information about the error.
CreateComponentVersionSourceType
string
The draft value.
CreateComponentVersionRequestInternalServerError
GetComponentDraftRequestInternalServerError
GetComponentVersionsRequestUnauthorizedError
updateComponentDraftResponse
object
Information about the component draft.
1 property
updateComponentResponse
object
Information about the component.
3 properties
GetComponentRequestForbiddenError
GetComponentVersionRequestUnauthorizedError
UpdateComponentDraftRequestInternalServerError
componentStatus
string
The component's lifecycle state: - active — The component is active and can be edited and published. - archived — The component is archived and read-only. Arch…
getComponent
object
1 property
meta
object
1 property
componentId
string
The component's ID.
GetComponentRequestInternalServerError
commonErrorNameMessage
object
1 property
GetAllComponentsRequestUnauthorizedError
componentData
object
Information about the component.
10 properties
UpdateComponentRequestForbiddenError
UpdateComponentRequestInternalServerError
CommonErrorTypeTitleDetailStatusType
createComponent
object
4 properties 3 required
GetComponentVersionRequestInternalServerError
getComponentVersions
object
2 properties
CreateComponentRequestUnauthorizedError
componentVersionData
object
Information about a component's version.
6 properties
createComponentResponse
object
Information about the component.
1 property
getComponentDraft
object
2 properties
componentHasVersions
boolean
GetComponentVersionsRequestForbiddenError
componentContentFormatData
string
The component's content format.
componentVersionId
string
The component version's ID.
componentExpandLatestVersion
string
GetAllComponentsRequestInternalServerError
updateComponentDraft
object
Information about the component draft.
2 properties
GetComponentVersionsRequestInternalServerError
CreateComponentVersionRequestUnauthorizedError
componentLibraryInclude
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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