Create a Monitor
Tool 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 ex…
Create an API
Tool to create a new API in Postman. Use when you need to create an API with a name, summary, and description in your Postman workspace.
Create an API
Tool to create a new API in a Postman workspace. Use when you need to create an API with a name and optional summary and description.
Create an Environment
Tool 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, et…
Create a Pull Request
Tool 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 colle…
Create Request in Collection
Tool 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.
Create a Request Comment
Tool 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.
Create a Response
Tool to create a request response in a Postman collection. Use when you need to add a saved response example to a specific request in a collection.
Create a Response Comment
Tool 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.
Create API Schema
Tool 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 con…
Create Mock Server Response
Tool to create a server response on a Postman mock server. Use when you need to simulate 5xx server-level responses (500, 503, etc.) for testing error conditions.
Create a Spec
Tool 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 O…
Create Spec File
Tool 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.
Create a Webhook
Tool to create a webhook that triggers a collection with a custom payload. Use when you need to set up a webhook endpoint that can trigger a Postman collection run. The webhook U…
Create a Workspace
Tool 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. Ret…
Create Collection
Tool to create a new Postman collection with specified name and configuration. Use when you need to create a new collection in Postman workspace. Returns the created collection's…
Create Environment
Tool to create a new Postman environment with specified name and variables. Use when you need to create a new environment in Postman workspace. Returns the created environment's …
Create Mock Server
Tool to create a new mock server for a Postman collection. Use when you need to set up a mock server that simulates API responses based on saved examples in a collection.
Create Monitor
Tool to create a new monitor to run a collection on a schedule. Use when you need to set up automated collection runs at specified intervals using cron expressions.
Create or Update a Schema File
Tool 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, fil…
Create API Version Relations
Tool to create new relations for an API version. Use when you need to link collections or mock servers to an API version as contract tests, test suites, documentation, or mocks.
Create Webhook
Tool to create a new webhook for a Postman collection. Use when you need to create a webhook that triggers a collection when called. Returns the created webhook's ID and name upo…
Delete a Collection
Tool to permanently delete a collection from Postman. Use when you need to remove a collection that is no longer needed.
Delete a collection's comment
Tool to delete a comment from an API's collection. Use when you need to remove a specific comment from a collection. On success, returns HTTP 204 No Content.
Delete a Folder
Tool 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…
Delete a Folder's Comment
Tool to delete a comment from a folder. Use when you need to remove a specific comment from a folder. Returns HTTP 204 No Content on successful deletion.
Delete an API
Tool to delete an API from Postman. Use when you need to permanently remove an API. On success, returns HTTP 204 No Content response.
Delete an API's Comment
Tool to delete a comment from an API. Use when you need to remove a comment from a specific API. On success, this returns an HTTP 204 No Content response indicating the comment w…
Delete an environment
Tool to delete an environment permanently in Postman. Use when you need to remove an environment that is no longer needed.
Delete a Request's Comment
Tool to delete a comment from a request. Use when you need to remove a specific comment from a request. On success, this returns an HTTP 204 No Content response.
Delete a Response
Tool to delete a response in a Postman collection. Use when you need to remove a saved response from a collection.
Delete a Response's Comment
Tool to delete a comment from a response. Use when you need to remove a specific comment from a collection response. On successful deletion, this returns HTTP 204 No Content.
Delete a Schema File
Tool to delete a file in an API schema. Use when you need to remove a specific file from a schema. On success, returns HTTP 204 No Content response.
Delete Mock Server Response
Tool to delete a mock server's server response. Use when you need to remove a specific response from a Postman mock server.
Delete a Spec
Tool to delete an API specification from Postman. Use when you need to permanently remove a specification. On success, returns HTTP 204 No Content response.
Delete Spec File
Tool to delete a file from an API specification. Use when you need to remove a specific file from a multi-file specification.
Delete a Workspace
Tool 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.
Delete Monitor
Tool to delete a monitor by its ID. Use when you need to permanently remove a monitor from Postman. The monitor ID must be provided to identify which monitor to delete.
Duplicate a Collection
Tool to create a duplicate of a collection in another workspace. Use when you need to copy an existing collection to a different workspace. Returns an asynchronous task that can …
Fork Collection
Tool to create a fork of a collection in a specified workspace. Use when you need to fork an existing collection to a workspace.
Generate Collection from Spec
Tool 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 asynchr…
Generate Spec from Collection
Tool 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 asynchrono…
Get Billing Account Details
Tool to retrieve Postman billing account details for the authenticated team. Use when you need to access account information such as account ID, team ID, account state, billing s…
Get Collection Comments
Tool 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.
Get Collection's Forks
Tool to get all forks of a specific collection. Use when you need to retrieve information about who has forked a collection, including fork IDs, users, and creation dates.
Get Collection Pull Requests
Tool 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 specif…
Get Collection Roles
Tool to get information about all roles in a collection. Use when you need to retrieve the IDs of all users, teams, and groups with access to view or edit a collection.
Get Folder Information
Tool 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 timest…
Get Folder Comments
Tool 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.
Get All API Releases
Tool to get all releases for a specific API version in Postman. Use when you need to list releases for an API version. Note: This endpoint is deprecated in Postman v10 and higher.
Get All APIs
Tool to get all APIs accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve APIs from Postman. Returns an array of API obje…
Get All APIs in Workspace
Tool to get all APIs in a specific Postman workspace. Use when you need to list or retrieve APIs from a workspace. Returns an array of API objects with their details.
Get All Collections
Tool to get all collections accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve collections from Postman. Returns an arr…
Get All Collections
Tool to get all collections accessible to the authenticated user. Use when you need to retrieve all your collections including subscribed collections. Returns detailed informatio…
Get All Environments
Tool to get all environments accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve environments from Postman. Returns an a…
Get All Forked Collections
Tool to retrieve all forked collections for the authenticated user. Use when you need to list or access all collections that the user has forked.
Get All Groups
Tool to get all user groups in a Postman team. Use when you need to list all groups and their details including member counts and timestamps. Returns an array of group objects wi…
Get All Linked Relations
Tool 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 AP…
Get All Mock Servers
Tool to get all active mock servers accessible to the authenticated user. Use when you need to list or retrieve mock servers from Postman. By default, returns only mock servers y…
Get All Monitors
Tool to get all monitors accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve monitors from Postman. Returns an array of …
Get All Workspace Roles
Tool to get information about all roles in a workspace based on the team's plan. Use when you need to retrieve the IDs of all users with different roles (Editor, Admin, Viewer) i…
Get All API Specifications
Tool 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 …
Get All Team Users
Tool to get information about all users on the Postman team. Use when you need to list all team members and their details including roles and join dates. Returns an array of user…
Get All Test Relations
Tool to retrieve all test relations for a specific API version. Use when you need to get test relations associated with an API version. Note: This endpoint is deprecated in Postm…
Get All API Versions
Tool to get all published versions of a specific API in Postman. Use when you need to list or retrieve version information for an API. Returns an array of version objects with th…
Get All Workspaces
Tool 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 w…
Get Monitor Information
Tool to retrieve information about a specific monitor in Postman. Use when you need to fetch monitor details including schedule, collection, environment, and run status.
Get API Information
Tool to retrieve information about a specific API in Postman. Use when you need to fetch API details including name, description, versions, and schemas.
Get API Comments
Tool to retrieve all comments left by users in an API. Use when you need to fetch all comments associated with a specific API.
Get API Version
Tool to get information about a specific API version in Postman. Use when you need to retrieve details about a particular version of an API. Returns version details including ID,…
Get an Environment
Tool to retrieve detailed information about a specific environment in Postman. Use when you need to fetch environment details including name, ID, owner, and all environment varia…
Get Environment Forks
Tool to retrieve all forked environments for a specific environment. Use when you need to list all environments that have been forked from a particular environment.
Get Request Information
Tool to retrieve information about a specific request in a Postman collection. Use when you need to fetch details about a request including its method, URL, headers, body, authen…
Get Request Comments
Tool 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.
Get Response Information
Tool to retrieve information about a saved response in a Postman collection. Use when you need to fetch details about a specific response including status, headers, body, and met…
Get Response Comments
Tool 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.
Get API Schema
Tool to retrieve information about an API schema from Postman. Use when you need to fetch schema details for a specific API. Optionally specify a version ID to get a schema publi…
Get API Specification
Tool to retrieve information about an API specification in Postman. Use when you need to fetch spec details including name, type, and timestamps.
Get Spec File Contents
Tool to get the contents of an API specification's file. Use when you need to retrieve the actual content and metadata of a specific file within a spec.
Get Spec Definition
Tool to get the complete contents of an API specification's definition. Use when you need to retrieve the full OpenAPI/Swagger specification content for a spec. Returns the raw d…
Get Specification Files
Tool to retrieve all files in an API specification from Postman. Use when you need to list or view specification files for a specific spec ID. Returns file metadata including IDs…
Get Spec's Generated Collections
Tool to retrieve all collections generated from an API specification in Postman. Use when you need to fetch collections that have been auto-generated from a spec. Returns metadat…
Get Async Collection Update Status
Tool 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 compl…
Get Team User
Tool to get information about a user on the Postman team. Use when you need to retrieve details about a specific team member including their ID, name, email, roles, and join date.
Get Authenticated User
Tool to get information about the authenticated user. Use when you need to retrieve details about the current authenticated user, including their user ID, username, and email add…
Get Workspace Details
Tool to get detailed information about a specific workspace by its ID. Use when you need to retrieve the complete structure of a workspace including all collections, environments…
Get Workspace Activity Feed
Tool 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 ch…
Get Workspace Roles
Tool to get the roles of users, user groups, and partners in a workspace. Use when you need to retrieve role assignments and understand who has what level of access to a specific…
Get Collection Access Keys
Tool 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 k…
Get Contract Test Relations
Tool to retrieve contract test relations for a specific API version. Use when you need to check contract test associations. Note: This endpoint is deprecated and may return limit…
Get documentation relations
Tool to get documentation relations for a specific API version. This endpoint is deprecated in Postman v10 and higher.
Get Duplication Task Status
Tool 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. Th…
Get Environment Relations
Tool to get environment relations for a specific API version. This endpoint is deprecated in Postman v10 and higher.
Get Generated Specification
Tool 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. Retur…
Get Workspace Global Variables
Tool 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, scr…
Get Integration Test Relations
Tool to get integration test relations for a specific API version. This endpoint is deprecated and may not return active data.
Get Resource Types
Tool to get all resource types supported by Postman's SCIM API. Use when you need to discover what resource types (e.g., User, Group) are available in the SCIM API and their corr…
Get Schema File Contents
Tool to get the contents of an API schema file at a specified path. Use when you need to retrieve the actual content of a schema file. Optionally specify a version ID to get file…
Get Schema Files
Tool 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 file…
Get Service Provider Configuration
Tool to get Postman's SCIM API service provider configuration information. Use when you need to discover supported SCIM operations, capabilities, and authentication schemes. This…
Get Source Collection Status
Tool 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 a…
Get Test Suite Relations
Tool to get test suite relations for a specific API version. Use when you need to retrieve the test suites associated with an API version. Note: This endpoint is deprecated and o…
Get Unclassified Relations
Tool to get unclassified relations for an API version in Postman. Use when you need to retrieve unclassified relations for a specific API version. This endpoint is for Postman v1…
Import OpenAPI Definition
Tool to import an OpenAPI definition into Postman as a new collection. Use when you need to convert an OpenAPI specification into a Postman collection within a specific workspace.
Import OpenAPI Specification
Tool 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 w…
List Account Invoices
Tool to get all invoices for a Postman billing account filtered by status. Use when you need to retrieve invoice history for an account. The account ID must first be obtained fro…
Merge a Fork
Tool to merge a forked collection back into its parent collection. This endpoint is deprecated. Use when you need to merge changes from a forked collection into the parent collec…
Merge a forked environment
Tool to merge a forked environment back into its parent environment. Use when you need to merge changes from a forked environment into the parent.
Publish a Mock Server
Tool 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.
Pull Source Changes into Fork
Tool to pull changes from a parent (source) collection into a forked collection. Use when you need to sync a forked collection with its parent.
Replace an Environment's Data
Tool 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 re…
Replace Collection Data Asynchronously
Tool 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 val…
Resolve a Comment Thread
Tool to resolve a comment thread and any associated replies. Use when you need to mark a comment thread as resolved. On success, this returns an HTTP 204 No Content response.
Review a Pull Request
Tool 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.
Run a Monitor
Tool to trigger an immediate run of a monitor and retrieve its execution results. Use when you need to manually execute a monitor outside of its scheduled runs.
Sync Collection with API Schema
Tool 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 w…
Sync Collection with Specification
Tool 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…
Sync Spec with Collection
Tool 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 …
Transfer Folders
Tool 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.
Transform Collection to OpenAPI
Tool to transform an existing Postman Collection into a stringified OpenAPI 3.0.3 definition. Use when you need to convert a collection to OpenAPI format for API documentation or…
Update a Folder
Tool to update a folder in a Postman collection. Use when you need to modify the name or description of an existing folder. For complete properties and information, see the Postm…
Update a Folder's Comment
Tool to update a comment on a folder. Use when you need to modify the text content of an existing comment on a specific folder in a collection.
Update a Mock Server
Tool 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 upd…
Update a Monitor
Tool to update an existing monitor in Postman. Use when you need to modify monitor properties like name, active status, collection, environment, options, notifications, or distri…
Update an API
Tool to update an existing API in Postman. Use when you need to modify the name, summary, or description of an API.
Update an API's Comment
Tool to update a comment on an API. Use when you need to modify the text content of an existing comment on a specific API.
Update an Environment
Tool 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 envi…
Update a Pull Request
Tool 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…
Update Request in Collection
Tool to update a request in a Postman collection. Use when you need to modify an existing request's name, method, URL, headers, or body following the Postman Collection Format.
Update a Request's Comment
Tool 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.
Update a Response
Tool 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 b…
Update a Response's Comment
Tool to update a comment on a response. Use when you need to modify the text content of an existing comment on a specific response within a collection.
Update a Server Response
Tool 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 le…
Update Spec File
Tool to update an API specification file's content. Use when you need to modify the contents of a specific file within a spec.
Update Spec Properties
Tool to update an API specification's properties such as its name. Use when you need to modify metadata of an existing spec.
Update a Workspace
Tool 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.
Update Workspace Global Variables
Tool 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 glob…
Update Collection Properties
Tool to update specific collection properties like name, description, authentication, variables, or events. Use when you need to partially update a collection without replacing t…