Postman

Postman Components API

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

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /components List components in the team library · Get all components #
Ask an LLM
“What reusable components are in my team's component library?”
“Can I list only archived components, or only ones with published versions?”
Tell an agent
List all components in the team library.
Show {type} components with status {status}.
POST /components Create a reusable component · Create a component #
Ask an LLM
“How do I add a reusable schema component to the team library?”
“Is a new component published right away or does it start as a draft?”
Tell an agent
Create a {type} component named {name} with content {content}.
Add component {name} of type {type} in {format} format containing {content}.
GET /components/{componentId} Get a component · Get a component #
Ask an LLM
“What is the status and latest published version of a component?”
“Can I expand a component to include whether it has versions?”
Tell an agent
Get component {componentId}.
Show component {componentId} expanded with {expand}.
PATCH /components/{componentId} Rename, archive or reactivate a component · Update a component #
Ask an LLM
“How do I archive a component that is no longer used?”
“Can I rename a component that has been archived?”
Tell an agent
Archive component {componentId}.
Reactivate archived component {componentId}.
GET /components/{componentId}/drafts Get a component's unpublished draft · Get a component draft #
Ask an LLM
“What unpublished edits are sitting in a component's working draft?”
“How does a component's draft differ from its last published version?”
Tell an agent
Show the current draft of component {componentId}.
Get the unpublished working copy of component {componentId}.
PATCH /components/{componentId}/drafts Edit a component's draft · Update a component draft #
Ask an LLM
“How do I change a component's content before publishing a new version?”
“Can I edit the draft of an archived component?”
Tell an agent
Update the draft of component {componentId} with content {content}.
Save {content} as {format} in component {componentId}'s draft.
GET /components/{componentId}/versions List a component's published versions · Get all component versions #
Ask an LLM
“Which versions of a component have been published?”
“Can I see the release history of one reusable component?”
Tell an agent
List the published versions of component {componentId}.
Show the version history of component {componentId}.
POST /components/{componentId}/versions Publish a component version from its draft · Create a component version #
Ask an LLM
“How do I publish the current draft of a component as a new version?”
“Can I publish a version of an archived component?”
Tell an agent
Publish component {componentId} as version {label}.
Release the draft of component {componentId} labelled {label}.
GET /components/{componentId}/versions/{versionId} Get one published component version · Get a component version #
Ask an LLM
“What did a specific published version of a component contain?”
“Can I fetch an older component version by its ID?”
Tell an agent
Get version {versionId} of component {componentId}.
Show the content of component {componentId} at published version {versionId}.

Documentation

📖
Documentation
https://www.postman.com/postman/postman-public-workspace/documentation/i2uqzpp/postman-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-components-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-component-version-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-create-component-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-create-component-version-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-update-component-draft-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-update-component-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-component-versions-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postman:postman-components-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

postman-components-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Components API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-components-api-openapi.yml