Postman

Postman API Catalog API

The apiCatalog API from Postman — 11 operation(s) for apicatalog.

GitHub OpenAPI

Operations 16

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 /api-catalog/discovery-services List discovered services · Get discovered services #
Ask an LLM
“Which services has API Catalog discovered in my infrastructure that aren't catalogued yet?”
“Can I filter discovered services by discovery source or status?”
Tell an agent
List the services discovered from source {discoverySource}.
Find discovered services matching {search} with status {status}.
POST /api-catalog/discovery-services Add discovered services to API Catalog · Add discovered services to the API Catalog #
Ask an LLM
“How do I promote discovered services into the API Catalog?”
“How many discovered services can I add to the catalog in one call?”
Tell an agent
Add these discovered services to the API Catalog: {discoveredServices}.
Catalog discovered services {discoveredServices}.
GET /api-catalog/discovery-services/{serviceId} Get a discovered service's details · Get a discovered service's information #
Ask an LLM
“What endpoints and OpenAPI spec were detected for a discovered service?”
“Can I see the inferred specification of a service before adding it to the catalog?”
Tell an agent
Show the details of discovered service {serviceId}.
Get the detected endpoints and spec for discovered service {serviceId}.
GET /api-catalog/services List catalogued services in an environment · Get all services #
Ask an LLM
“Which services are catalogued in my production system environment?”
“Can I filter catalog services by tag or governance group?”
Tell an agent
List all catalogued services in system environment {systemEnvironmentId}.
Show services tagged {tags} in system environment {systemEnvironmentId}.
GET /api-catalog/services/{serviceId} Get a catalogued service's health and ownership · Get a service by ID #
Ask an LLM
“What is the health, traffic and compliance status of one service in the catalog?”
“Who owns a catalogued service and what does it depend on?”
Tell an agent
Show service {serviceId} in system environment {systemEnvironmentId}.
Get the ownership and dependencies of catalog service {serviceId} in environment {systemEnvironmentId}.
GET /api-catalog/services/{serviceId}/endpoints List a service's observed endpoints and metrics · Get a service's endpoints #
Ask an LLM
“Which endpoints of a service are actually receiving traffic, and how are they performing?”
“Can I filter a service's observed endpoints by HTTP method or response code?”
Tell an agent
List the observed endpoints of service {serviceId} in environment {systemEnvironmentId}.
Show service {serviceId}'s endpoints returning {responseCodes} in environment {systemEnvironmentId}.
GET /api-catalog/services/{serviceId}/monitor-runs List a service's scheduled monitor runs · Get a service's monitor runs #
Ask an LLM
“How have the scheduled monitors for a catalogued service been doing lately?”
“Can I see only the failed monitor runs for one service?”
Tell an agent
List monitor runs for service {serviceId} in environment {systemEnvironmentId}.
Show service {serviceId}'s monitor runs with status {status} in environment {systemEnvironmentId}.
GET /api-catalog/services/{serviceId}/spec-lints List a service's spec lint results · Get a service's specification lints #
Ask an LLM
“How many governance issues did the latest spec lint find on a service?”
“Can I filter a service's lint runs by severity?”
Tell an agent
Show the specification lint runs for service {serviceId}.
List {severity} lint issues on spec {specId} for service {serviceId}.
GET /api-catalog/services/{serviceId}/ci-runs List a service's CI collection runs · Get a service's CI runs #
Ask an LLM
“Which CI pipeline runs executed collections against a service, and did they pass?”
“Can I filter a service's CI runs by Git branch or repository?”
Tell an agent
List CI runs for service {serviceId} in environment {systemEnvironmentId}.
Show CI runs on branch {branch} for service {serviceId} in environment {systemEnvironmentId}.
GET /api-catalog/system-environments List the team's system environments · Get all system environments #
Ask an LLM
“What system environments has my team set up in the API Catalog?”
“Can I list only the production system environments?”
Tell an agent
List all of my team's system environments.
Show system environments where production is {isProduction}.
POST /api-catalog/system-environments Create a system environment · Create a system environment #
Ask an LLM
“How do I set up a new system environment like staging in the API Catalog?”
“Can I mark a new system environment as production when creating it?”
Tell an agent
Create a system environment named {name} with color {color}.
Add a production system environment called {name} colored {color}.
GET /api-catalog/system-environments/{systemEnvironmentId} Get a system environment · Get a system environment #
Ask an LLM
“What are the settings of one system environment?”
“Is a given system environment flagged as production?”
Tell an agent
Get system environment {systemEnvironmentId}.
Show the name, color and production flag of system environment {systemEnvironmentId}.
PATCH /api-catalog/system-environments/{systemEnvironmentId} Update a system environment · Update a system environment #
Ask an LLM
“How do I rename or recolor a system environment?”
“Does a renamed system environment need a unique name within the team?”
Tell an agent
Rename system environment {systemEnvironmentId} to {name}.
Change the color of system environment {systemEnvironmentId} to {color}.
GET /api-catalog/system-environments/{systemEnvironmentId}/associations List workspace environments linked to a system environment · Get a system environment's associations #
Ask an LLM
“Which workspace environments are mapped to a system environment?”
“Can I see the associations for a single workspace only?”
Tell an agent
List the workspace-environment associations of system environment {systemEnvironmentId}.
Show which environments in workspace {workspaceId} map to system environment {systemEnvironmentId}.
POST /api-catalog/system-environments/{systemEnvironmentId}/associations Link workspace environments to a system environment · Add system environment associations #
Ask an LLM
“How do I map my Postman workspace environments to a system environment?”
“Can I allow a partial success when some environment associations fail?”
Tell an agent
Associate workspace environments {workspaceEnvironmentIds} with system environment {systemEnvironmentId}.
Link environments {workspaceEnvironmentIds} to system environment {systemEnvironmentId} with allowPartial set to {allowPartial}.
DELETE /api-catalog/system-environments/{systemEnvironmentId}/associations Unlink workspace environments from a system environment · Remove system environment associations #
Ask an LLM
“How do I detach workspace environments from a system environment?”
“Can I remove several environment associations at once?”
Tell an agent destructive · confirm first
Remove workspace environments {workspaceEnvironmentIds} from system environment {systemEnvironmentId}.
Unlink {workspaceEnvironmentIds} from system environment {systemEnvironmentId}.

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-apicatalog-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-api-catalog-discovery-service-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-create-api-catalog-system-environment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-update-api-catalog-system-environment-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-api-catalog-service-endpoints-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-api-catalog-service-specification-lints-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-api-catalog-service-monitor-runs-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-apicatalog-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-apicatalog-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman API Catalog 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 (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-apicatalog-api-openapi.yml