Postman

Postman Collections API

The Collections API lets you programmatically create, read, update, and delete Postman Collections including requests, folders, scripts, and environments. Powers CI/CD integration, sync, and collection generation pipelines.

GitHub OpenAPI

Operations 34

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

PUT /collection-merges Merge or pull fork changes asynchronously · Merge or pull changes into a collection fork #
Ask an LLM
“How do I merge a forked Postman collection into its parent in the background and track it as a task?”
“Can I pull the parent's changes into my fork with the async merge endpoint by swapping source and destination?”
Tell an agent
Start an async merge of fork {source} into parent collection {destination} using the {strategy} strategy.
Queue an async pull of parent {source} into my fork {destination} with merge strategy {strategy}.
GET /collection-merges-tasks/{taskId} Check a collection merge or pull task · Get merge or pull task status #
Ask an LLM
“Did my async collection merge or pull task finish, or is it still running?”
“How long is the status of a finished collection merge task kept around?”
Tell an agent
Check the status of collection merge task {taskId}.
Tell me whether the pull-changes task {taskId} succeeded or failed.
GET /collections List my collections · Get all collections #
Ask an LLM
“What collections do I have access to, including ones I'm subscribed to?”
“Can I list only the collections in one workspace, or find a collection by name?”
Tell an agent
List all my Postman collections.
List the collections in workspace {workspace}.
POST /collections Create a collection · Create a collection #
Ask an LLM
“How do I create a new collection in a specific workspace through the API?”
“Which collection format does the create-collection endpoint expect?”
Tell an agent
Create a new collection in workspace {workspace}.
Create collection {collection} in workspace {workspace} using the v2.1.0 format.
GET /collections/collection-forks List the collections I have forked · Get all forked collections #
Ask an LLM
“Which collections have I forked?”
“Can I see my own collection forks sorted newest first?”
Tell an agent
List all the collections I've forked.
Show my forked collections, {limit} at a time.
POST /collections/fork/{collectionId} Fork a collection into a workspace · Create a fork #
Ask an LLM
“How do I fork an existing collection into another workspace?”
“Do I have to give a label when I fork a collection?”
Tell an agent
Fork collection {collectionId} into workspace {workspace} with the label {label}.
Make a fork of collection {collectionId} in workspace {workspace}.
POST /collections/merge Merge a fork using the deprecated endpoint · Merge a fork #
Ask an LLM
“Is there an older synchronous endpoint for merging a forked collection back into its parent?”
“What role do I need to merge a fork with the deprecated merge endpoint?”
Tell an agent
Use the deprecated merge endpoint to merge fork {source} into parent collection {destination}.
Merge fork {source} into {destination} the legacy way with strategy {strategy}.
GET /collections/{collectionId} Get a collection · Get a collection #
Ask an LLM
“How do I fetch the full contents of one collection by its ID?”
“Can I read a collection with just a read-only access key instead of an API key?”
Tell an agent
Get collection {collectionId}.
Fetch collection {collectionId} using the access key {access_key}.
PUT /collections/{collectionId} Replace a collection's contents · Replace a collection's data #
Ask an LLM
“How do I overwrite an entire collection with new contents?”
“What happens to existing items if I replace a collection without including their IDs?”
Tell an agent
Replace everything in collection {collectionId} with {collection}.
Overwrite collection {collectionId} asynchronously and give me the task to track.
DELETE /collections/{collectionId} Delete a collection · Delete a collection #
Ask an LLM
“How do I permanently delete a collection?”
“Can I remove a collection I no longer need through the API?”
Tell an agent destructive · confirm first
Delete collection {collectionId}.
Remove the collection {collectionId} from Postman.
PATCH /collections/{collectionId} Update a collection's name, events or variables · Update part of a collection #
Ask an LLM
“Can I rename a collection without replacing all of its requests?”
“How do I change just a collection's variables or scripts?”
Tell an agent
Rename collection {collectionId} and keep its items as they are.
Partially update collection {collectionId} with {collection}.
GET /collections/{collectionId}/comments List comments on a collection · Get a collection's comments #
Ask an LLM
“What comments have people left on this collection?”
“Can I read the whole comment history of a collection?”
Tell an agent
List the comments on collection {collectionId}.
Show me who commented on collection {collectionId} and what they said.
POST /collections/{collectionId}/comments Comment on a collection · Create a collection comment #
Ask an LLM
“How do I leave a comment on a collection?”
“Can I reply to an existing collection comment thread, and how long can a comment be?”
Tell an agent
Comment {body} on collection {collectionId}.
Reply {body} in thread {threadId} on collection {collectionId}.
PUT /collections/{collectionId}/comments/{commentId} Edit a comment on a collection · Update a collection's comment #
Ask an LLM
“Can I edit a comment I already posted on a collection?”
“Is there a character limit when editing a collection comment?”
Tell an agent
Change comment {commentId} on collection {collectionId} to {body}.
Edit my collection comment {commentId} in {collectionId} to say {body}.
DELETE /collections/{collectionId}/comments/{commentId} Delete a comment on a collection · Delete a collection's comment #
Ask an LLM
“What happens to the replies if I delete the first comment in a collection thread?”
“How do I remove a comment from a collection?”
Tell an agent destructive · confirm first
Delete comment {commentId} from collection {collectionId}.
Remove collection comment {commentId} on {collectionId} and its thread if it's the first one.
POST /collections/{collectionId}/duplicates Duplicate a collection into another workspace · Duplicate a collection #
Ask an LLM
“How do I copy a collection into a different workspace?”
“Can I add a suffix to the name of a duplicated collection?”
Tell an agent
Duplicate collection {collectionId} into workspace {workspace}.
Copy collection {collectionId} to workspace {workspace} with the name suffix {suffix}.
GET /collections/{collectionId}/forks List a collection's forks · Get a collection's forks #
Ask an LLM
“Who has forked this collection and when?”
“Can I list every fork made from one of my collections?”
Tell an agent
List the forks of collection {collectionId}.
Show who forked collection {collectionId}, newest forks first.
PUT /collections/{collectionId}/public-documentations Publish a collection's documentation · Publish documentation #
Ask an LLM
“How do I make a collection's documentation public to anyone with the link?”
“Can I choose the colors and layout when publishing collection docs?”
Tell an agent
Publish the documentation for collection {collectionId} with theme colors {customColor}.
Publish docs for collection {collectionId} in the {documentationLayout} layout.
DELETE /collections/{collectionId}/public-documentations Unpublish a collection's documentation · Unpublish documentation #
Ask an LLM
“How do I take a collection's public documentation offline?”
“Can I make published collection docs private again?”
Tell an agent destructive · confirm first
Unpublish the documentation for collection {collectionId}.
Take down the public docs for collection {collectionId}.
PUT /collections/{collectionId}/pulls Pull parent changes into a forked collection · Pull source changes #
Ask an LLM
“My fork is behind its parent collection; how do I bring in the latest changes?”
“Is there a synchronous way to pull source changes into a forked collection?”
Tell an agent
Pull the parent collection's changes into my fork {collectionId}.
Sync forked collection {collectionId} with its source now.
GET /collections/{collectionId}/pull-requests List a collection's pull requests · Get a collection's pull requests #
Ask an LLM
“What pull requests are open against this collection?”
“Can I see the status and link of each pull request on a collection?”
Tell an agent
List the pull requests for collection {collectionId}.
Show the pull request statuses on collection {collectionId}.
POST /collections/{collectionId}/pull-requests Open a pull request from a forked collection · Create a pull request #
Ask an LLM
“How do I open a pull request from my forked collection into the parent?”
“Can I assign reviewers when creating a collection pull request?”
Tell an agent
Open a pull request titled {title} from fork {collectionId} into {destinationId} with reviewers {reviewers}.
Create a pull request from {collectionId} to parent {destinationId}, titled {title}, reviewed by {reviewers}.
GET /collections/{collectionId}/roles See who can view or edit a collection · Get a collection's roles #
Ask an LLM
“Which users, teams and groups have access to this collection?”
“Who has editor access on a given collection?”
Tell an agent
List the roles on collection {collectionId}.
Show who can view or edit collection {collectionId}.
PATCH /collections/{collectionId}/roles Change who can access a collection · Update a collection's roles #
Ask an LLM
“How do I give a user editor access to a collection?”
“Can I change the roles of groups or teams on a collection, and who is allowed to?”
Tell an agent
Update the roles on collection {collectionId} to {roles}.
Grant or revoke collection access on {collectionId} with {roles}.
GET /collections/{collectionId}/source-status Check whether a fork is behind its parent · Get source collection's status #
Ask an LLM
“Has the parent collection changed since I forked it?”
“How can I tell if my forked collection is out of date with its source?”
Tell an agent
Check whether the source of forked collection {collectionId} is ahead.
Tell me if fork {collectionId} is missing changes from its parent.
GET /collections/{collectionId}/transformations Convert a collection to OpenAPI · Transform collection to OpenAPI #
Ask an LLM
“Can I generate an OpenAPI definition from an existing collection?”
“Does converting a collection to OpenAPI create an API, and can I get JSON or YAML?”
Tell an agent
Convert collection {collectionId} to an OpenAPI definition.
Export collection {collectionId} as OpenAPI in {format} format.
POST /collection-folders-transfers Copy or move folders between collections · Transfer folders #
Ask an LLM
“How do I move folders from one collection into another?”
“Can I copy folders into another folder instead of moving them?”
Tell an agent
{mode} folders {ids} into {target} at position {location}.
Move folders {ids} into collection or folder {target}, placed {location}; mode {mode}.
POST /collection-requests-transfers Copy or move requests between collections · Transfer requests #
Ask an LLM
“Can I copy saved requests from one collection into another collection or folder?”
“What's the way to move several requests at once into a different folder?”
Tell an agent
Transfer requests {ids} to {target} at {location} using mode {mode}.
Copy requests {ids} into folder {target}, positioned {location}, with mode {mode}.
POST /collection-responses-transfers Copy or move saved responses to a request · Transfer responses #
Ask an LLM
“Can I move saved example responses from one request to another?”
“How do I copy example responses onto a different request?”
Tell an agent
Transfer responses {ids} to request {target} at {location} with mode {mode}.
Move example responses {ids} onto request {target}, placed {location}; mode {mode}.
GET /collection-duplicate-tasks/{taskId} Check a collection duplication task · Get duplication task status #
Ask an LLM
“Has my collection duplication finished yet?”
“What's the status of copying a collection into another workspace?”
Tell an agent
Check the status of duplication task {taskId}.
Tell me if collection copy task {taskId} is done.
GET /collection-updates-tasks/{taskId} Check an async collection update task · Get async collection update status #
Ask an LLM
“Did my asynchronous collection replacement complete?”
“What is the status of a background collection update?”
Tell an agent
Check the status of async collection update task {taskId}.
Tell me whether collection update task {taskId} succeeded.
GET /collections/{collectionId}/requests List all requests in a collection · Postman Get all requests in a collection #
Ask an LLM
“What requests does this collection contain, with their methods and URLs?”
“Can I see every request in a collection along with its folder?”
Tell an agent
List every request in collection {collectionId}.
Show the methods and URLs of all requests in collection {collectionId}.
GET /collections/{collectionId}/folders List all folders in a collection · Postman Get all folders in a collection #
Ask an LLM
“What's the folder structure inside this collection?”
“Can I list all folders of a collection with their hierarchy?”
Tell an agent
List all folders in collection {collectionId}.
Show the folder hierarchy of collection {collectionId}.
GET /collections/{collectionId}/responses List all saved responses in a collection · Postman Get all responses in a collection #
Ask an LLM
“Which saved example responses exist across a collection?”
“Can I pull every example response with its status code and body from one collection?”
Tell an agent
List all saved example responses in collection {collectionId}.
Show status codes and bodies of every example response in collection {collectionId}.

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/postman/openapi/postman-collections-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-publish-documentation-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-publish-documentation-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-async-collection-fork-merge-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-pull-request-created-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-transfer-collection-items-schema.json
📊
JSONSchema
https://artifacts.apis.io/postman/json-schema/postman-merge-collection-fork-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:collections-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-collections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Collections API
  version: 1.0.0
  description: 'Operations tagged collections across 2 of this provider''s published API definitions: postman-api-openapi.yml, postman-collections-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
- url: https://api.getpostman.com
  description: Postman Production API Server
tags:


# --- truncated at 32 KB (183 KB total) ---
# Full source: https://artifacts.apis.io/postman/openapi/postman-collections-api-openapi.yml