Skip to main content
Postman logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 135
  • Triggers: 0
  • Slug: POSTMAN
  • Version: 20261101_00

Tools

Slug: 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

string
Optional workspace ID where the collection will be created. If not specified, the collection is created in the user’s default workspace
object
required
Collection object containing info (name, description, schema) and item array (requests/folders)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The text content of the comment to create on the API collection.
string
required
The API’s unique identifier (UUID). This identifies the API containing the collection.
integer
Optional thread ID to reply to an existing comment thread. Include this to create a reply on an existing comment.
string
required
The collection’s unique identifier (UUID). This identifies the specific collection to comment on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the collection to be created
string
required
The unique identifier (UUID) of the API
array
required
List of relation(s) to be created. Each relation must specify a type from the allowed values
string
required
The unique identifier (UUID) of the schema from which to create the collection
string
Optional workspace ID where the collection will be created. If not specified, the collection is created in the user’s default workspace
string
required
The unique identifier (UUID) of the API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_A_FOLDERTool to create a folder in a Postman collection. Use when you need to organize requests by creating a new folder within a collection. For complete details, see the Postman Collection Format documentation.

Input Parameters

string
required
The name of the folder to create
string
Optional description of the folder explaining its purpose
string
required
The unique identifier of the collection to create the folder in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_A_FOLDER_COMMENTTool to create a comment on a folder. Use when you need to add a comment to a specific folder in a collection.

Input Parameters

string
required
The comment text content to post on the folder.
string
required
The unique identifier (UID) of the folder to comment on.
string
required
The unique identifier (UID) of the collection containing the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_A_FORK2Tool to create a fork from an existing environment into a workspace. Use when you need to fork an environment to a specified workspace.

Input Parameters

string
required
A name for the forked environment
string
required
The workspace ID where the forked environment will be created
string
required
The unique identifier (UID) of the environment to fork

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Mock server configuration containing name, collection UID, optional environment UID, and privacy setting
string
The workspace ID where the mock server should be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Monitor configuration object containing name, collection, schedule, and optional environment
string
required
The workspace ID where the monitor will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_AN_APITool 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.

Input Parameters

object
required
The API object containing name, summary, and description
string
required
The workspace ID where the API will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Environment object containing name and optional array of environment variables
string
required
The workspace ID where the environment will be created. Required to associate the environment with a specific workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The title of the pull request. This should summarize the changes being proposed.
array
Array of reviewer user IDs or user groups who should review the pull request. Can be an empty array if no specific reviewers are required.
string
A detailed description of the changes in the pull request. Provides context for reviewers.
string
required
The unique identifier (UID) of the forked collection from which to create the pull request. Format: {owner}-{collectionId}
string
required
The UID of the destination (parent) collection where the changes will be merged. Format: {owner}-{collectionId}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the request to create
object
required
The request object containing method, URL, headers, body, and other request details following the Postman Collection Format
string
required
The unique identifier of the collection where the request will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The comment text content to post on the request.
integer
Optional thread ID to reply to an existing comment. If provided, this comment will be added as a reply to the specified thread.
string
required
The request’s unique ID (UID). This identifies the specific request to create a comment on.
string
required
The collection’s unique ID (UID). This identifies the collection containing the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_A_RESPONSETool 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.

Input Parameters

string
The response body as a string
integer
The HTTP status code
string
required
The name of the response example
array
Array of header objects with key and value properties
string
The status text (e.g., OK, Not Found, Bad Request)
string
required
The unique identifier of the collection where the response will be created
object
The original request object structure.
string
required
The unique identifier of the parent request to which this response will be attached
string
The preview language for the response body (e.g., json, html, xml)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The comment text content to post on the response.
integer
Optional thread ID to reply to an existing comment. If provided, this comment will be added as a reply to the specified thread.
string
required
The response’s unique ID (UID). This identifies the specific response to create a comment on.
string
required
The collection’s unique ID (UID). This identifies the collection containing the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type of schema being created. Common values include ‘openapi:3’ (OpenAPI 3.0), ‘openapi:2’ (Swagger 2.0), ‘proto’ (Protocol Buffers), ‘graphql’, etc.
array
required
List of files that make up the schema. Each file must have a path and content. For single-file schemas, provide one file; for multi-file schemas, provide all referenced files
string
required
The unique identifier (UUID) of the API for which to create the schema

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_A_SERVER_RESPONSETool 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.

Input Parameters

string
required
The unique identifier of the mock server (UUID format)
object
required
Server response configuration containing name, status code, and optional body/headers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the API specification to create
string
required
The type of specification. Common values include ‘OPENAPI:3.0’, ‘OPENAPI:3.1’, ‘ASYNCAPI:2.0’
array
required
Array of files for the specification. Each file must have a path and content property. For single-file specs, provide one file; for multi-file specs, provide multiple files
string
required
The workspace ID where the spec will be created. This is a UUID format string identifying the target workspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The file path within the spec (e.g., ‘components/schemas.yaml’, ‘paths/users.yaml’). This defines the file location in the spec structure
string
required
The content of the file to create. Must be a valid YAML or JSON string
string
required
The unique identifier of the API specification in which to create the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_A_WEBHOOKTool 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 URL is available in the webhookUrl property of the response.

Input Parameters

object
required
Webhook configuration object containing name and collection UID
string
required
The workspace ID where the webhook will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The workspace object containing name, type, and optional description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the API containing the schema. This is the API’s ID in Postman.
string
required
The stringified JSON content of the schema file. This should be a JSON string representation of your schema content. For complex JSON objects, ensure proper escaping.
string
required
The path to the schema file to create or update. This is the file path within the schema structure (e.g., ‘index.json’, ‘components.json’, ‘schemas/openapi.yaml’).
string
required
The unique identifier of the schema to which the file belongs. This is the schema’s ID within the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_CREATE_RELATIONSTool 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.

Input Parameters

array
Array of mock server UIDs
string
required
The unique identifier of the API
array
Array of collection UIDs for test suites
array
Array of collection UIDs for contract testing
array
Array of collection UIDs for documentation
string
required
The unique identifier of the API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_COLLECTIONTool to permanently delete a collection from Postman. Use when you need to remove a collection that is no longer needed.

Input Parameters

string
required
The unique identifier (UID) or ID of the collection to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_COLLECTIONS_COMMENTDelete a specific comment from an API’s collection. A 204 response from the API is returned as a success result with a message.

Input Parameters

string
required
The API’s ID
integer
required
The comment’s ID
string
required
The collection’s UID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The folder’s ID. This is the unique identifier for the folder to delete. Note: folder IDs should not contain spaces to avoid 404 errors.
string
required
The collection’s ID. This is the unique identifier for the collection containing the folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_FOLDERS_COMMENTDelete a specific comment from a folder in a Postman collection. Returns a success indicator after a successful request.

Input Parameters

integer
required
The ID of the comment to delete
string
required
The unique identifier (UID) of the folder
string
required
The unique identifier (UID) of the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_AN_APIDelete an API from Postman by ID. Returns a success flag when the request succeeds.

Input Parameters

string
required
The ID of the API to delete. This is the unique identifier for the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_AN_APIS_COMMENTDelete a specific comment from an API. Returns a success indicator after a successful request.

Input Parameters

string
required
The API ID. This is the unique identifier of the API from which to delete the comment
string
required
The comment ID. This is the unique identifier of the comment to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_AN_ENVIRONMENTTool to delete an environment permanently in Postman. Use when you need to remove an environment that is no longer needed.

Input Parameters

string
required
The environment ID or UID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The comment’s ID to delete. This identifies the specific comment to be removed.
string
required
The request’s unique ID (UID). This identifies the specific request containing the comment.
string
required
The collection’s unique ID (UID). This identifies the collection containing the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_RESPONSETool to delete a response in a Postman collection. Use when you need to remove a saved response from a collection.

Input Parameters

string
required
The unique identifier of the response to delete
string
required
The unique identifier of the collection containing the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_RESPONSES_COMMENTDelete a specific comment from a collection response. Returns a success indicator for successful requests and also when the API returns HTTP 404.

Input Parameters

integer
required
The unique identifier for the comment to delete.
string
required
The unique identifier for the response.
string
required
The unique identifier for the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_SCHEMA_FILEDelete a specific file from an API schema. Returns a success indicator after a successful request.

Input Parameters

string
required
The API’s ID. This is the unique identifier for the API containing the schema.
string
required
The path to the schema file to delete. This is the file path within the schema.
string
required
The schema’s ID. This is the unique identifier for the schema containing the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_SERVER_RESPONSETool to delete a mock server’s server response. Use when you need to remove a specific response from a Postman mock server.

Input Parameters

string
required
The mock server’s unique identifier (UUID format)
string
required
The server response’s unique identifier (UUID format) to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_SPECDelete an API specification from Postman by ID. Returns a success flag when the request succeeds.

Input Parameters

string
required
The ID of the API specification to delete. This is the unique identifier for the specification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_A_SPEC_FILETool to delete a file from an API specification. Use when you need to remove a specific file from a multi-file specification.

Input Parameters

string
required
The unique identifier of the API specification containing the file to delete
string
required
The path to the file within the specification to delete (e.g., ‘components/schemas.yaml’, ‘openapi.yaml’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the workspace to delete. This is the unique identifier assigned to the workspace when it was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DELETE_MONITORTool 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.

Input Parameters

string
required
The ID of the monitor to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_DUPLICATE_A_COLLECTIONTool 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 be tracked using the duplication task status endpoint.

Input Parameters

string
required
The ID of the workspace where the duplicated collection will be created
string
required
The unique identifier (UUID) of the collection to duplicate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_FORK_COLLECTIONTool to create a fork of a collection in a specified workspace. Use when you need to fork an existing collection to a workspace.

Input Parameters

string
Label or name for the fork. If not provided, the fork will be created with a default label.
string
required
The workspace ID where the forked collection will be created. This is a required parameter for creating a fork.
string
required
The unique identifier (UUID) of the collection to fork

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name for the generated collection. This will be the display name in Postman.
object
Options for configuring the collection generation from the specification.
string
required
The unique identifier of the API specification from which to generate the collection.
string
The type of element to generate. Must be ‘collection’ for collection generation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name for the generated API specification. This will be used to identify the generated spec.
string
required
The specification type to generate. Must be ‘OPENAPI:3.0’ for OpenAPI 3.0 specification format.
string ("json" | "yaml")
required
The format of the generated specification file. Choose ‘json’ for JSON format or ‘yaml’ for YAML format.
string
The type of element to generate. Valid value is ‘spec’ for API specification generation.
string
required
The unique identifier for the collection (UID format). This identifies the collection to generate the specification from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_ACCOUNTSTool 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 slots, sales channel, or billing email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The API’s unique identifier (UUID). This identifies the API containing the collection.
string
required
The collection’s unique identifier (UUID). This identifies the specific collection to retrieve comments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_COLLECTIONS_FORKSRetrieve a page of forks of a Postman collection, including fork IDs, owners, and creation dates. The response may include pagination metadata.

Input Parameters

string
required
The unique identifier (UUID) of the collection whose forks you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the collection in the format {owner}-{collectionId}. This identifies the collection to retrieve pull requests from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_COLLECTIONS_ROLESRetrieve user and team role information for a Postman collection, including IDs and roles.

Input Parameters

string
required
The unique identifier of the collection to retrieve roles for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the folder to retrieve. Note: folder IDs should not contain spaces to avoid 404 errors.
string
required
The unique identifier of the collection containing the folder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The folder’s unique ID (UID). This identifies the specific folder to retrieve comments from.
string
required
The collection’s unique ID (UID). This identifies the collection containing the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_ALL_API_RELEASESTool 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.

Input Parameters

string
required
The unique identifier of the API
string
required
The unique identifier of the API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of APIs to return per page. Defaults to the API’s default limit.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.
string
Filter by workspace ID to get APIs specific to a workspace. If not provided, returns all APIs accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of collections to return per page.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.
string
Optional workspace ID to filter collections. Can be empty to get all collections across all workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of environments to return per page.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.
string
Filter by workspace ID to get environments specific to a workspace. If not provided, returns all environments accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_ALL_FORKED_COLLECTIONSTool to retrieve all forked collections for the authenticated user. Use when you need to list or access all collections that the user has forked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of groups to return per page.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the API. This is the API’s ID returned when listing or creating APIs.
string
required
The unique identifier of the API version. This is the version ID returned when listing or creating API versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of mock servers to return per page.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.
string
Filter by workspace ID to get mock servers specific to a workspace. If not provided, returns all mock servers you created across all workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of monitors to return per page. Defaults to 25.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.
string
Filter by workspace ID to get monitors specific to a workspace. If not provided, returns all monitors accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of specs to return per page. Defaults to the API’s default limit.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.
string
required
The workspace ID to fetch API specifications from. This is required to retrieve specs for a specific workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_ALL_TEAM_USERSTool 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 objects with their IDs, names, usernames, emails, roles, and join timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_ALL_TEST_RELATIONSRetrieve test relations for a specific API version. This endpoint is deprecated in Postman v10 and higher; an HTTP 404 is returned as an empty test list.

Input Parameters

string
required
The unique identifier of the API.
string
required
The unique identifier of the API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of versions to return per page. Defaults to the API’s default limit.
string
required
The unique identifier of the API whose versions you want to retrieve.
string
A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("personal" | "team" | "public")
Filter by workspace type. Use ‘personal’ for personal workspaces, ‘team’ for team workspaces, or ‘public’ for public workspaces. If not provided, returns all workspaces accessible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_MONITORTool to retrieve information about a specific monitor in Postman. Use when you need to fetch monitor details including schedule, collection, environment, and run status.

Input Parameters

string
required
The unique identifier of the monitor to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_AN_APITool to retrieve information about a specific API in Postman. Use when you need to fetch API details including name, description, versions, and schemas.

Input Parameters

string
required
The unique identifier of the API to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_AN_APIS_COMMENTSTool to retrieve all comments left by users in an API. Use when you need to fetch all comments associated with a specific API.

Input Parameters

string
required
The API’s unique identifier (UUID). This identifies the API to retrieve comments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_AN_API_VERSIONTool 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, name, creation date, and associated schemas.

Input Parameters

string
required
The unique identifier of the API.
string
required
The unique identifier of the API version to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_AN_ENVIRONMENTTool 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 variables.

Input Parameters

string
required
The unique identifier (ID or UID) of the environment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_AN_ENVIRONMENTS_FORKSTool 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.

Input Parameters

string
required
The environment’s unique identifier (UID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_REQUESTTool 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, authentication, and associated scripts.

Input Parameters

string
required
The unique identifier of the request to retrieve
string
required
The unique identifier of the collection containing the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The request’s unique ID (UID). This identifies the specific request to retrieve comments from.
string
required
The collection’s unique ID (UID). This identifies the collection containing the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_RESPONSETool 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 metadata.

Input Parameters

string
required
The unique identifier of the response to retrieve
string
required
The unique identifier of the collection containing the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The response’s unique ID (UID). This identifies the specific response to retrieve comments from.
string
required
The collection’s unique ID (UID). This identifies the collection containing the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_SCHEMATool 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 published in a specific API version.

Input Parameters

string
required
The API’s unique identifier
string
required
The schema’s unique identifier
string
Optional. The API version ID to get a schema published in a specific API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_SPECTool to retrieve information about an API specification in Postman. Use when you need to fetch spec details including name, type, and timestamps.

Input Parameters

string
required
The unique identifier of the API specification to retrieve. This is a UUID format string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_SPEC_FILETool 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.

Input Parameters

string
required
The ID of the API specification
string
required
The path of the file within the spec (e.g., ‘openapi.yaml’, ‘components/schemas.yaml’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the API specification to retrieve the definition for. This is a UUID format string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_SPECS_FILESList a page of files in a Postman API specification, returning file metadata such as IDs, names, paths, types, and timestamps.

Input Parameters

string
required
The ID of the API specification whose files you want to retrieve. This is the unique identifier for the specification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_SPECS_GENERATED_COLLECTIONSRetrieve a page of collections generated from a Postman API specification, with response metadata.

Input Parameters

string
required
The unique identifier of the API specification
string
The type of element to retrieve generations for. Valid value: ‘collection’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the collection update task. Obtained from PUT /collections/{collectionId} with Prefer: respond-async header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_TEAM_USERTool 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.

Input Parameters

integer
required
The ID of the user to retrieve information about

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_AUTHENTICATED_USERTool 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 address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_WORKSPACETool 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, APIs, mocks, and monitors.

Input Parameters

string
required
The unique identifier of the workspace to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The maximum number of activities to return. Used for pagination.
string
Cursor for pagination. Use the nextCursor value from the previous response to fetch the next page of results.
string
required
The ID of the workspace to get the activity feed for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_A_WORKSPACES_ROLESTool 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 workspace.

Input Parameters

string
required
The unique identifier of the workspace to retrieve roles for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_CONTRACT_TEST_RELATIONSRetrieve contract test relations for a specific API version. This endpoint is deprecated and may return limited or no data; a 404 response is returned as an empty relations list.

Input Parameters

string
required
The unique identifier of the API
string
required
The unique identifier of the API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_DOCUMENTATION_RELATIONSTool to get documentation relations for a specific API version. This endpoint is deprecated in Postman v10 and higher.

Input Parameters

string
required
The ID of the API
string
required
The ID of the API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the collection duplication task. Obtained from POST /collections/{collectionId}/duplicates endpoint response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_ENVIRONMENT_RELATIONSGet environment relations for a specific API version. This endpoint is deprecated in Postman v10 and higher; an HTTP 404 is returned as an empty environment list.

Input Parameters

string
required
The unique ID of the API.
string
required
The unique ID of the API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The type of generated element to retrieve. Use ‘spec’ for API specifications. This is typically ‘spec’ for OpenAPI/Swagger specifications generated from the collection.
string
required
The unique identifier for the collection. This is the collection’s UID (with team/user prefix).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the workspace to retrieve global variables from. Can be obtained from the GET /workspaces endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_INTEGRATION_TEST_RELATIONSTool to get integration test relations for a specific API version. This endpoint is deprecated and may not return active data.

Input Parameters

string
required
The unique identifier of the API
string
required
The unique identifier of the API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_RESOURCE_TYPESTool 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 corresponding endpoints and schemas.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_SCHEMA_FILE_CONTENTSTool 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 contents from a specific API version.

Input Parameters

string
required
The API’s unique identifier
string
required
The path of the file within the schema (e.g., ‘index.yaml’, ‘schemas/openapi.yaml’)
string
required
The schema’s unique identifier
string
Optional query parameter to get schema file contents published in an API version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the API containing the schema.
string
required
The unique identifier of the schema whose files you want to retrieve.
string
Optional version ID to get schema files published in a specific API version. If not provided, returns files from the latest version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of a forked collection. The endpoint only works with forked collections, not regular collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_TEST_SUITE_RELATIONSRetrieve test suite relations for a specific API version. This endpoint is deprecated; 404 responses and certain 400 errors are returned as an empty list with a deprecation message.

Input Parameters

string
required
The unique identifier of the API to get test suite relations for.
string
required
The unique identifier of the API version to get test suite relations for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_GET_UNCLASSIFIED_RELATIONSTool 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 v10 and higher.

Input Parameters

string
required
The API identifier (UUID format)
string
required
The API version identifier (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type of import input. Use ‘string’ when providing the OpenAPI specification as a JSON/YAML string, or ‘file’ when uploading a file. Common value is ‘string’.
string
required
The OpenAPI specification content as a JSON or YAML string. Must be a valid OpenAPI 3.0+ specification with required fields like ‘openapi’, ‘info’, and ‘paths’. Ensure proper JSON formatting if using type=‘string’.
string
required
The unique identifier of the workspace where the OpenAPI specification will be imported. The imported OpenAPI will be created as a collection in this workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_LIST_ACCOUNT_INVOICESTool 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 from the GET /accounts endpoint.

Input Parameters

string
Filter invoices by status (e.g., PAID). If not provided, returns all invoices.
string
required
The billing account ID obtained from GET /accounts endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UID of the forked collection (source) to merge from
string
Optional merge strategy: ‘deleteSource’ (merge and delete forked collection) or ‘updateSourceWithDestination’ (merge and update both collections)
string
required
The UID of the parent collection (destination) to merge into

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_MERGE_A_FORK2Tool to merge a forked environment back into its parent environment. Use when you need to merge changes from a forked environment into the parent.

Input Parameters

string
required
The UID of the forked (source) environment to merge from
string
required
The UID of the parent (destination) environment where changes will be merged into

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the mock server to publish. Publishing a mock server sets its Access Control configuration to public.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_PULL_SOURCE_CHANGES2Tool to pull changes from a parent (source) collection into a forked collection. Use when you need to sync a forked collection with its parent.

Input Parameters

string
required
The ID of the forked collection that will receive the changes from its parent (source) collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Environment object containing name and array of environment variables. This completely replaces the environment’s data
string
required
The unique identifier (ID or UID) of the environment to replace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The complete collection object to replace the existing collection. IMPORTANT: Include the collection’s ID values in item, variable, and other nested objects to preserve them. If you do not include IDs, the endpoint removes existing items and creates new items.
string
required
The unique identifier (ID or UID) of the collection to replace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_RESOLVE_A_COMMENT_THREADResolve a comment thread and its associated replies in Postman. On a 204 response, the tool returns a success indicator.

Input Parameters

integer
required
The ID of the comment thread to resolve. This is obtained from the threadId field when creating or retrieving comments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("approve" | "decline" | "unapprove")
required
The review action to perform on the pull request. ‘approve’ to approve the PR, ‘decline’ to decline it, or ‘unapprove’ to revoke a previous approval
string
required
The unique identifier of the pull request to review

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_RUN_A_MONITORTool 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.

Input Parameters

string
required
The unique identifier (ID or UID) of the monitor to run

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the API. Must be in UUID format.
string
required
The unique identifier of the collection that is attached to the API. Format: userId-collectionId.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the API specification to sync with the collection. This is the source specification that the collection was generated from.
string
required
The UID of a collection that was generated from an API specification. This collection will be synchronized with its source specification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the API specification to sync. Must be in UUID format.
string
required
The unique identifier of the collection to sync with the specification. The collection must have been generated from this spec, and the spec must be a single-file specification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of folder unique identifiers (UIDs) to transfer. Each UID must be in format ‘owner-folderId’ (e.g., ‘50304422-f172eb50-ded9-dcc1-5c6a-1ad2a604bf55’). All folders must exist and be accessible.
string ("copy" | "move")
required
Transfer mode: ‘copy’ creates duplicates of folders in target, ‘move’ relocates folders to target (removes from source).
object
required
Target location where folders should be transferred. Specify the model type (collection or folder) and its UID.
object
required
Position within the target where folders should be placed. Specify ‘start’ or ‘end’ for the position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_TRANSFORM_COLLECTION_TO_OPENAPITool 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 interoperability with other tools.

Input Parameters

string
required
The unique identifier of the collection to transform into OpenAPI format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_A_FOLDERTool 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 Postman Collection Format documentation.

Input Parameters

string
The new name for the folder
string
required
The unique identifier of the folder to update
string
Optional updated description for the folder explaining its purpose
string
required
The unique identifier of the collection containing the folder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_A_FOLDERS_COMMENTTool 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.

Input Parameters

string
required
The updated text content of the comment.
string
required
The unique identifier of the comment to update.
string
required
The unique identifier (UID) of the folder containing the comment.
string
required
The unique identifier (UID) of the collection containing the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Mock server configuration containing the collection UID (required), and optional name, environment UID, and privacy setting
string
required
The unique identifier of the mock server to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The monitor object containing fields to update. All fields are optional - only include fields you want to update.
string
required
The unique identifier (ID or UID) of the monitor to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The API object containing fields to update. Include at least one of: name, summary, or description.
string
required
The unique identifier of the API to update. This is the API ID returned when the API was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_AN_APIS_COMMENTTool to update a comment on an API. Use when you need to modify the text content of an existing comment on a specific API.

Input Parameters

string
required
The updated text content of the comment.
string
required
The API’s unique identifier. This identifies the API containing the comment to update.
integer
required
The comment’s unique identifier. This is the ID of the comment to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of JSON Patch operations to apply to the environment. Each operation modifies a specific field using the RFC 6902 format
string
required
The unique identifier (ID or UID) of the environment to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The updated title of the pull request. This should summarize the changes being proposed.
array
required
Array of reviewer user IDs who should review the pull request. Can be an empty array if no specific reviewers are required. This field is required even when updating a pull request.
string
required
The UID of the source collection (forked collection). Format: {owner}-{collectionId}. This field is required even when updating a pull request.
string
required
The updated description for the pull request. Provides context for reviewers about the changes.
string
required
The UID of the destination collection (parent collection). Format: {owner}-{collectionId}. This field is required even when updating a pull request.
string
required
The unique identifier of the pull request to update. This is the pull request ID returned when the pull request was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_A_REQUESTTool 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.

Input Parameters

string
The updated name of the request
object
Request object following Postman Collection Format.
string
required
The unique identifier of the request to update
string
required
The unique identifier of the collection containing the request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The updated text content of the comment.
integer
required
The comment’s unique identifier. This is the ID of the comment to update.
string
required
The request’s unique ID (UID). This identifies the specific request containing the comment.
string
required
The collection’s unique ID (UID). This identifies the collection containing the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The response object containing the properties to update. Can include name, status, code, header, cookie, body, originalRequest, etc.
string
required
The unique identifier of the response to update
string
required
The unique identifier of the collection containing the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_A_RESPONSES_COMMENTTool 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.

Input Parameters

string
required
The updated text content of the comment.
string
required
The unique identifier of the comment to update.
string
required
The unique identifier (UID) of the response containing the comment.
string
required
The unique identifier (UID) of the collection containing the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The mock server’s unique identifier (UUID format)
object
required
The server response object containing the properties to update. Include at least one property: name, status_code, language, body, or headers.
string
required
The server response’s unique identifier (UUID format) to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_A_SPEC_FILETool to update an API specification file’s content. Use when you need to modify the contents of a specific file within a spec.

Input Parameters

string
required
The updated content of the spec file in YAML or JSON format
string
required
The unique identifier of the API specification
string
required
The path of the file within the spec to update (e.g., ‘openapi.yaml’, ‘components/schemas.yaml’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: POSTMAN_UPDATE_A_SPECS_PROPERTIESTool to update an API specification’s properties such as its name. Use when you need to modify metadata of an existing spec.

Input Parameters

string
The new name for the API specification
string
required
The unique identifier of the API specification to update. This is a UUID format string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The workspace object containing fields to update. The ‘type’ field is required, while ‘name’ and ‘description’ are optional.
string
required
The unique identifier of the workspace to update. This is the workspace ID returned when the workspace was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of global variable objects to set. This replaces all existing global variables in the workspace with the provided list.
string
required
The unique identifier of the workspace to update global variables for. Can be obtained from the GET /workspaces endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

object
required
The collection object containing the properties to update. Can include info (with name, description), auth, variables, or events properties. Only the specified properties will be updated.
string
required
The unique identifier (ID or UID) of the collection to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not