- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 135
- Triggers: 0
- Slug:
POSTMAN - Version: 20261101_00
Tools
Create a Collection
Create a Collection
POSTMAN_CREATE_A_COLLECTIONTool to create a new Postman collection in a specific workspace or the default workspace. Use when you need to create a collection with workspace specification. For complete collection format details, refer to the Postman Collection Format documentation.Input Parameters
Output
Create a Collection Comment
Create a Collection Comment
POSTMAN_CREATE_A_COLLECTION_COMMENTTool to create a comment on an API’s collection. Use when you need to add a comment to a specific collection within an API. To create a reply on an existing comment, include the thread_id in the request.Input Parameters
Output
Create Collection from Schema
Create Collection from Schema
POSTMAN_CREATE_A_COLLECTION_FROM_A_SCHEMATool to create a collection from a schema and link it to an API with specified relations. Note: This endpoint is deprecated in Postman v10 and higher. Use when you need to generate a collection from an API schema and establish relations like contract tests or documentation.Input Parameters
Output
Create a Folder
Create a Folder
Create a Folder Comment
Create a Folder Comment
Create Environment Fork
Create Environment Fork
Create a Mock Server
Create a Mock Server
POSTMAN_CREATE_A_MOCK_SERVERTool to create a new mock server in a Postman collection. Use when you need to create a mock server to simulate API endpoints for testing or development. Returns the created mock server’s details including the mockUrl which can be used to make requests.Input Parameters
Output
Create a Monitor
Create a Monitor
POSTMAN_CREATE_A_MONITORTool to create a new monitor in a specific workspace to run a collection on a schedule. Use when you need to set up automated collection runs at specified intervals using cron expressions within a workspace.Input Parameters
Output
Create an API
Create an API
Create an Environment
Create an Environment
POSTMAN_CREATE_AN_ENVIRONMENTTool to create a new environment in a Postman workspace. Use when you need to create a new environment with variables for different settings (development, production, testing, etc.). Returns the created environment’s ID, name, and UID upon successful creation.Input Parameters
Output
Create a Pull Request
Create a Pull Request
POSTMAN_CREATE_A_PULL_REQUESTTool to create a pull request for a forked collection into its parent collection. Use when you need to propose changes from a forked collection to be merged into the parent collection. The forked collection must exist before creating a pull request.Input Parameters
Output
Create Request in Collection
Create Request in Collection
POSTMAN_CREATE_A_REQUESTTool to create a new request in a Postman collection. Use when you need to add a request to an existing collection with specified method, URL, headers, and body.Input Parameters
Output
Create a Request Comment
Create a Request Comment
POSTMAN_CREATE_A_REQUEST_COMMENTTool to create a comment on a request. Use when you need to add a comment to a specific request within a collection or reply to an existing comment thread.Input Parameters
Output
Create a Response
Create a Response
Create a Response Comment
Create a Response Comment
POSTMAN_CREATE_A_RESPONSE_COMMENTTool to create a comment on a response. Use when you need to add a comment to a specific response within a collection or reply to an existing comment thread.Input Parameters
Output
Create API Schema
Create API Schema
POSTMAN_CREATE_A_SCHEMATool to create a schema for an API in Postman. Use when you need to add a schema definition (such as OpenAPI, GraphQL, or Protocol Buffers) to an existing API. The schema can consist of single or multiple files. Returns the created schema’s ID and metadata upon successful creation.Input Parameters
Output
Create Mock Server Response
Create Mock Server Response
Create a Spec
Create a Spec
POSTMAN_CREATE_A_SPECTool to create an API specification in Postman’s Spec Hub. Use when you need to create single or multi-file specifications in a workspace. Supports various spec types including OpenAPI 3.0, OpenAPI 3.1, and AsyncAPI 2.0.Input Parameters
Output
Create Spec File
Create Spec File
POSTMAN_CREATE_A_SPEC_FILETool to create a new file in an API specification. Use when you need to add a new file (such as schema definitions, path configurations, or components) to an existing spec.Input Parameters
Output
Create a Webhook
Create a Webhook
Create a Workspace
Create a Workspace
POSTMAN_CREATE_A_WORKSPACETool to create a new workspace in Postman. Use when you need to create a workspace with a specified name, type (personal, team, private, or public), and optional description. Returns the created workspace’s ID, name, and type upon successful creation.Input Parameters
Output
Create or Update a Schema File
Create or Update a Schema File
POSTMAN_CREATE_OR_UPDATE_A_SCHEMA_FILETool to create or update an API schema file in Postman. Use when you need to add a new schema file or modify an existing one within an API schema. Requires API ID, schema ID, file path, and stringified JSON content.Input Parameters
Output
Create API Version Relations
Create API Version Relations
Delete a Collection
Delete a Collection
Delete a collection's comment
Delete a collection's comment
Delete a Folder
Delete a Folder
POSTMAN_DELETE_A_FOLDERTool to delete a folder in a Postman collection. Use when you need to remove a folder and all its contents from a collection. The folder ID should not contain spaces to avoid 404 errors.Input Parameters
Output
Delete a Folder's Comment
Delete a Folder's Comment
Delete an API
Delete an API
Delete an API's Comment
Delete an API's Comment
Delete an environment
Delete an environment
Delete a Request's Comment
Delete a Request's Comment
POSTMAN_DELETE_A_REQUESTS_COMMENTDelete a specific comment from a request in a Postman collection. Returns a success indicator after a successful request.Input Parameters
Output
Delete a Response
Delete a Response
Delete a Response's Comment
Delete a Response's Comment
Delete a Schema File
Delete a Schema File
Delete Mock Server Response
Delete Mock Server Response
Delete a Spec
Delete a Spec
Delete Spec File
Delete Spec File
Delete a Workspace
Delete a Workspace
POSTMAN_DELETE_A_WORKSPACETool to delete a Postman workspace permanently. Use when you need to remove a workspace and all its contents. Deletion is permanent and cannot be undone.Input Parameters
Output
Delete Monitor
Delete Monitor
Duplicate a Collection
Duplicate a Collection
Fork Collection
Fork Collection
Generate Collection from Spec
Generate Collection from Spec
POSTMAN_GENERATE_A_COLLECTION_FROM_SPECTool to generate a Postman collection from an OpenAPI 2.0, 3.0, or 3.1 specification. Use when you need to create a collection from an existing API spec. The operation is asynchronous and returns a task ID and polling URL to check the generation status.Input Parameters
Output
Generate Spec from Collection
Generate Spec from Collection
POSTMAN_GENERATE_SPEC_FROM_COLLECTIONTool to generate an API specification from a Postman collection. Use when you need to create an OpenAPI 3.0 specification from an existing collection. The operation is asynchronous and returns a task ID and polling URL to check the generation status.Input Parameters
Output
Get Billing Account Details
Get Billing Account Details
Get Collection Comments
Get Collection Comments
POSTMAN_GET_A_COLLECTIONS_COMMENTSTool to retrieve all comments left by users in an API’s collection. Use when you need to fetch all comments associated with a specific collection within an API.Input Parameters
Output
Get Collection's Forks
Get Collection's Forks
Get Collection Pull Requests
Get Collection Pull Requests
POSTMAN_GET_A_COLLECTIONS_PULL_REQUESTSTool to get information about a collection’s pull requests including source and destination IDs, status, and URLs. Use when you need to retrieve pull request details for a specific collection.Input Parameters
Output
Get Collection Roles
Get Collection Roles
Get Folder Information
Get Folder Information
POSTMAN_GET_A_FOLDERTool to retrieve information about a folder in a Postman collection. Use when you need to fetch details about a specific folder including its name, description, owner, and timestamps.Input Parameters
Output
Get Folder Comments
Get Folder Comments
POSTMAN_GET_A_FOLDERS_COMMENTSTool to retrieve all comments left by users in a folder. Use when you need to fetch all comments associated with a specific folder within a collection.Input Parameters
Output
Get All API Releases
Get All API Releases
Get All APIs
Get All APIs
POSTMAN_GET_ALL_APISList accessible Postman APIs, optionally filtered by workspace. Returns a page of API metadata and a cursor for fetching further results.Input Parameters
Output
Get All Collections
Get All Collections
POSTMAN_GET_ALL_COLLECTIONS2List collections accessible to the authenticated user, including subscribed collections, optionally filtered by workspace. Returns a page of collection details and a cursor for fetching further results.Input Parameters
Output
Get All Environments
Get All Environments
POSTMAN_GET_ALL_ENVIRONMENTSList environments accessible to the authenticated user, optionally filtered by workspace. Returns a page of environment objects and pagination metadata; use the cursor to request another page.Input Parameters
Output
Get All Forked Collections
Get All Forked Collections
Get All Groups
Get All Groups
POSTMAN_GET_ALL_GROUPSList user groups in a Postman team, including group details such as member counts and timestamps. Results are paginated; use the cursor to request another page.Input Parameters
Output
Get All Linked Relations
Get All Linked Relations
POSTMAN_GET_ALL_LINKED_RELATIONSTool to retrieve all linked relations for a specific API version in Postman. Use when you need to discover what collections, documentation, mocks, or monitors are linked to an API version.Input Parameters
Output
Get All Mock Servers
Get All Mock Servers
POSTMAN_GET_ALL_MOCK_SERVERSList active Postman mock servers, optionally filtered by workspace; by default, the list covers mock servers you created across workspaces. Results are paginated; use the cursor to request another page.Input Parameters
Output
Get All Monitors
Get All Monitors
POSTMAN_GET_ALL_MONITORSList monitors accessible to the authenticated user, optionally filtered by workspace. Returns a page of monitor objects and pagination metadata; use the cursor to request another page.Input Parameters
Output
Get All API Specifications
Get All API Specifications
POSTMAN_GET_ALL_SPECSTool to get all API specifications in a workspace. Use when you need to list or retrieve API specs from a specific Postman workspace. Returns an array of spec objects with their IDs, names, types, and timestamps, along with pagination metadata.Input Parameters
Output
Get All Team Users
Get All Team Users
Get All Test Relations
Get All Test Relations
Get All API Versions
Get All API Versions
POSTMAN_GET_ALL_VERSIONSList published versions of a specific Postman API, returning version IDs and names. Results are paginated; use the returned cursor to fetch subsequent pages.Input Parameters
Output
Get All Workspaces
Get All Workspaces
POSTMAN_GET_ALL_WORKSPACESTool to get all workspaces accessible to the authenticated user with optional type filtering. Use when you need to list or retrieve workspaces from Postman. Returns an array of workspace objects with their IDs, names, and types.Input Parameters
Output
Get Monitor Information
Get Monitor Information
Get API Information
Get API Information
Get API Comments
Get API Comments
Get API Version
Get API Version
Get an Environment
Get an Environment
Get Environment Forks
Get Environment Forks
Get Request Information
Get Request Information
Get Request Comments
Get Request Comments
POSTMAN_GET_A_REQUESTS_COMMENTSTool to retrieve all comments left by users in a request. Use when you need to fetch all comments associated with a specific request within a collection.Input Parameters
Output
Get Response Information
Get Response Information
Get Response Comments
Get Response Comments
POSTMAN_GET_A_RESPONSES_COMMENTSTool to retrieve all comments left by users in a response. Use when you need to fetch all comments associated with a specific response within a collection.Input Parameters
Output
Get API Schema
Get API Schema
Get API Specification
Get API Specification
Get Spec File Contents
Get Spec File Contents
Get Spec Definition
Get Spec Definition
POSTMAN_GET_A_SPECS_DEFINITIONRetrieve an API specification’s definition as a string. JSON object responses are formatted as JSON; other responses are returned as text.Input Parameters
Output
Get Specification Files
Get Specification Files
Get Spec's Generated Collections
Get Spec's Generated Collections
Get Async Collection Update Status
Get Async Collection Update Status
POSTMAN_GET_ASYNC_COLLECTION_UPDATE_STATUSTool to get the status of an asynchronous collection update task. Use when you need to check whether a previously initiated async collection update is still processing, has completed successfully, or has failed. The task ID is obtained from PUT /collections/{collectionId} endpoint when using the Prefer: respond-async header.Input Parameters
Output
Get Team User
Get Team User
Get Authenticated User
Get Authenticated User
Get Workspace Details
Get Workspace Details
Get Workspace Activity Feed
Get Workspace Activity Feed
POSTMAN_GET_A_WORKSPACES_ACTIVITY_FEEDTool to get a workspace’s activity feed showing who added or removed collections, environments, or elements, and users joining or leaving. Use when you need to track workspace changes and user activity.Input Parameters
Output
Get Workspace Roles
Get Workspace Roles
Get Collection Access Keys
Get Collection Access Keys
POSTMAN_GET_COLLECTION_ACCESS_KEYSTool to retrieve all personal and team collection access keys for the authenticated user. Use when you need to list or manage collection access keys. Returns an array of access key objects with their IDs, tokens, status, and associated collection information.Output
Get Contract Test Relations
Get Contract Test Relations
Get documentation relations
Get documentation relations
Get Duplication Task Status
Get Duplication Task Status
POSTMAN_GET_DUPLICATION_TASK_STATUSTool to get the status of a collection duplication task. Use when you need to check whether a previously initiated collection duplication is still processing or has completed. The task ID must first be obtained from the POST /collections/{collectionId}/duplicates endpoint.Input Parameters
Output
Get Environment Relations
Get Environment Relations
Get Generated Specification
Get Generated Specification
POSTMAN_GET_GENERATED_SPECTool to retrieve the API specification generated for a Postman collection. Use when you need to fetch OpenAPI/Swagger specs that have been auto-generated from a collection. Returns metadata and an array of generated specifications.Input Parameters
Output
Get Workspace Global Variables
Get Workspace Global Variables
POSTMAN_GET_GLOBAL_VARIABLESTool to get a workspace’s global variables. Use when you need to retrieve global variables that are available throughout a workspace for access between collections, requests, scripts, and environments. Note that this endpoint only works with personal or team workspaces, not public workspaces.Input Parameters
Output
Get Integration Test Relations
Get Integration Test Relations
Get Resource Types
Get Resource Types
Get Schema File Contents
Get Schema File Contents
Get Schema Files
Get Schema Files
POSTMAN_GET_SCHEMA_FILESTool to retrieve files in an API schema from Postman. Use when you need to list or view schema files for a specific API and schema ID. Optionally filter by version ID to get files from a particular API version.Input Parameters
Output
Get Service Provider Configuration
Get Service Provider Configuration
POSTMAN_GET_SERVICE_PROVIDER_CONFIGURATIONTool to get Postman’s SCIM API service provider configuration information. Use when you need to discover supported SCIM operations, capabilities, and authentication schemes. This endpoint returns configuration details including support for PATCH, bulk operations, filtering, sorting, and ETag handling.Output
Get Source Collection Status
Get Source Collection Status
POSTMAN_GET_SOURCE_COLLECTIONS_STATUSTool to check whether there is a change between a forked collection and its parent (source) collection. Use when you need to determine if the source collection has updates that are not yet in the forked collection. This endpoint only works with forked collections; attempting to use it with regular collections will result in an error.Input Parameters
Output
Get Test Suite Relations
Get Test Suite Relations
Get Unclassified Relations
Get Unclassified Relations
Import OpenAPI Specification
Import OpenAPI Specification
POSTMAN_IMPORT_OPENAPITool to import an OpenAPI specification into Postman as a new collection. Use when you need to convert an OpenAPI 3.0+ specification into a Postman collection within a specific workspace. The imported specification will be automatically converted to a Postman collection with all endpoints, request parameters, and documentation.Input Parameters
Output
List Account Invoices
List Account Invoices
Merge a Fork
Merge a Fork
POSTMAN_MERGE_A_FORKMerge a forked collection into its parent using the deprecated endpoint. An optional strategy can delete the fork after merging or update both collections.Input Parameters
Output
Merge a forked environment
Merge a forked environment
Publish a Mock Server
Publish a Mock Server
POSTMAN_PUBLISH_A_MOCK_SERVERTool to publish a mock server in Postman. Use when you need to make a mock server publicly accessible. Publishing sets the mock server’s Access Control configuration to public.Input Parameters
Output
Pull Source Changes into Fork
Pull Source Changes into Fork
Replace an Environment's Data
Replace an Environment's Data
POSTMAN_REPLACE_AN_ENVIRONMENTS_DATATool to completely replace an environment’s data with new variables and values. Use when you need to update an entire environment by replacing all its contents. This operation replaces ALL existing variables with the ones provided in the request.Input Parameters
Output
Replace Collection Data Asynchronously
Replace Collection Data Asynchronously
POSTMAN_REPLACE_COLLECTIONS_DATA_ASYNCHRONOUSLYTool to replace the entire contents of a collection asynchronously. Use when you need to completely replace a collection with new data. IMPORTANT: Include the collection’s ID values in item, variable, and other nested objects to preserve them. If you do not include IDs, existing items will be removed and new items will be created.Input Parameters
Output
Resolve a Comment Thread
Resolve a Comment Thread
Review a Pull Request
Review a Pull Request
POSTMAN_REVIEW_A_PULL_REQUESTTool to update the review status of a pull request by approving, declining, or unapproving it. Use when you need to perform a review action on a Postman pull request.Input Parameters
Output
Run a Monitor
Run a Monitor
Sync Collection with API Schema
Sync Collection with API Schema
POSTMAN_SYNC_COLLECTION_WITH_SCHEMATool to sync a collection attached to an API with the API schema. This is an asynchronous endpoint that returns HTTP 202 Accepted. Use when you need to synchronize a collection with changes made to the API schema. The collection must already be attached to the API. Returns a task ID that can be used to check the status of the sync operation.Input Parameters
Output
Sync Collection with Specification
Sync Collection with Specification
POSTMAN_SYNC_COLLECTION_WITH_SPECTool to sync a collection generated from an API specification. This is an asynchronous operation that returns HTTP 202 Accepted. Use when you need to update a collection to match the latest version of its source API specification. The collection must have been generated from a spec.Input Parameters
Output
Sync Spec with Collection
Sync Spec with Collection
POSTMAN_SYNC_SPEC_WITH_COLLECTIONTool to sync an API specification with a linked collection. This is an asynchronous operation that returns HTTP 202 Accepted with task tracking information. Use when you need to synchronize changes from a spec to its generated collection. Prerequisites: the collection must be generated from the spec, and the spec must be single-file.Input Parameters
Output
Transfer Folders
Transfer Folders
POSTMAN_TRANSFER_FOLDERSTool to copy or move folders into a collection or folder. Use when you need to reorganize collections by transferring folders between collections or into other folders.Input Parameters
Output
Transform Collection to OpenAPI
Transform Collection to OpenAPI
Update a Folder
Update a Folder
Update a Folder's Comment
Update a Folder's Comment
Update a Mock Server
Update a Mock Server
POSTMAN_UPDATE_A_MOCK_SERVERTool to update an existing mock server. Use when you need to change a mock server’s name, collection, environment, or privacy settings. The collection UID is required for all updates.Input Parameters
Output
Update a Monitor
Update a Monitor
POSTMAN_UPDATE_A_MONITORTool to update an existing monitor in Postman. Use when you need to modify monitor properties like name, active status, collection, environment, options, notifications, or distribution settings.Input Parameters
Output
Update an API
Update an API
POSTMAN_UPDATE_AN_APITool to update an existing API in Postman. Use when you need to modify the name, summary, or description of an API.Input Parameters
Output
Update an API's Comment
Update an API's Comment
Update an Environment
Update an Environment
POSTMAN_UPDATE_AN_ENVIRONMENTTool to update specific environment properties using JSON Patch operations (RFC 6902). Use when you need to modify environment name or variables without replacing the entire environment.Input Parameters
Output
Update a Pull Request
Update a Pull Request
POSTMAN_UPDATE_A_PULL_REQUESTTool to update an open pull request in Postman. Use when you need to modify the title, description, source, destination, or reviewers of an existing pull request. All fields must be provided in the request.Input Parameters
Output
Update Request in Collection
Update Request in Collection
Update a Request's Comment
Update a Request's Comment
POSTMAN_UPDATE_A_REQUESTS_COMMENTTool to update a comment on a request. Use when you need to modify the text content of an existing comment on a specific request within a collection.Input Parameters
Output
Update a Response
Update a Response
POSTMAN_UPDATE_A_RESPONSETool to update a response in a Postman collection. Use when you need to modify properties of an existing saved response example such as name, status, code, headers, cookies, or body.Input Parameters
Output
Update a Response's Comment
Update a Response's Comment
Update a Server Response
Update a Server Response
POSTMAN_UPDATE_A_SERVER_RESPONSETool to update a mock server’s server response. Use when you need to modify properties of an existing server response such as name, status code, language, body, or headers. At least one property must be included in the update request.Input Parameters
Output
Update Spec File
Update Spec File
Update Spec Properties
Update Spec Properties
Update a Workspace
Update a Workspace
POSTMAN_UPDATE_A_WORKSPACETool to update an existing workspace in Postman. Use when you need to modify the name, type, or description of a workspace. The ‘type’ field is required for all updates.Input Parameters
Output
Update Workspace Global Variables
Update Workspace Global Variables
POSTMAN_UPDATE_GLOBAL_VARIABLESTool to update and replace a workspace’s global variables. Use when you need to set or replace all global variables in a workspace. Note: This endpoint replaces all existing global variables with the provided list.Input Parameters
Output
Update Collection Properties
Update Collection Properties
POSTMAN_UPDATE_PART_OF_A_COLLECTIONTool to update specific collection properties like name, description, authentication, variables, or events. Use when you need to partially update a collection without replacing the entire collection structure. Returns the updated collection information after the changes are applied.