# Postman Postman is an API platform for building, testing, and managing APIs with powerful collaboration features. - **Category:** developer tools - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 135 - **Triggers:** 0 - **Slug:** `POSTMAN` - **Version:** 20260312_00 ## Tools ### Create a Collection **Slug:** `POSTMAN_CREATE_A_COLLECTION` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | No | Optional workspace ID where the collection will be created. If not specified, the collection is created in the user's default workspace | | `collection` | object | Yes | Collection object containing info (name, description, schema) and item array (requests/folders) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Collection Comment **Slug:** `POSTMAN_CREATE_A_COLLECTION_COMMENT` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The text content of the comment to create on the API collection. | | `api_id` | string | Yes | The API's unique identifier (UUID). This identifies the API containing the collection. | | `thread_id` | integer | No | Optional thread ID to reply to an existing comment thread. Include this to create a reply on an existing comment. | | `collection_id` | string | Yes | The collection's unique identifier (UUID). This identifies the specific collection to comment on. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Collection from Schema **Slug:** `POSTMAN_CREATE_A_COLLECTION_FROM_A_SCHEMA` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the collection to be created | | `api_id` | string | Yes | The unique identifier (UUID) of the API | | `relations` | array | Yes | List of relation(s) to be created. Each relation must specify a type from the allowed values | | `schema_id` | string | Yes | The unique identifier (UUID) of the schema from which to create the collection | | `workspace` | string | No | Optional workspace ID where the collection will be created. If not specified, the collection is created in the user's default workspace | | `api_version_id` | string | Yes | The unique identifier (UUID) of the API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Folder **Slug:** `POSTMAN_CREATE_A_FOLDER` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the folder to create | | `description` | string | No | Optional description of the folder explaining its purpose | | `collection_id` | string | Yes | The unique identifier of the collection to create the folder in | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Folder Comment **Slug:** `POSTMAN_CREATE_A_FOLDER_COMMENT` Tool to create a comment on a folder. Use when you need to add a comment to a specific folder in a collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The comment text content to post on the folder. | | `folder_uid` | string | Yes | The unique identifier (UID) of the folder to comment on. | | `collection_uid` | string | Yes | The unique identifier (UID) of the collection containing the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Environment Fork **Slug:** `POSTMAN_CREATE_A_FORK2` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `fork_name` | string | Yes | A name for the forked environment | | `workspace` | string | Yes | The workspace ID where the forked environment will be created | | `environment_uid` | string | Yes | The unique identifier (UID) of the environment to fork | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Mock Server **Slug:** `POSTMAN_CREATE_A_MOCK_SERVER` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock` | object | Yes | Mock server configuration containing name, collection UID, optional environment UID, and privacy setting | | `workspace` | string | No | The workspace ID where the mock server should be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Monitor **Slug:** `POSTMAN_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 expressions within a workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `monitor` | object | Yes | Monitor configuration object containing name, collection, schedule, and optional environment | | `workspace` | string | Yes | The workspace ID where the monitor will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an API **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api` | object | Yes | The API object containing name, summary, and description | | `workspace_id` | string | Yes | The workspace ID where the API will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create an Environment **Slug:** `POSTMAN_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, etc.). Returns the created environment's ID, name, and UID upon successful creation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `environment` | object | Yes | Environment object containing name and optional array of environment variables | | `workspace_id` | string | Yes | The workspace ID where the environment will be created. Required to associate the environment with a specific workspace | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Pull Request **Slug:** `POSTMAN_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 collection. The forked collection must exist before creating a pull request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | Yes | The title of the pull request. This should summarize the changes being proposed. | | `reviewers` | array | No | 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. | | `description` | string | No | A detailed description of the changes in the pull request. Provides context for reviewers. | | `collection_uid` | string | Yes | The unique identifier (UID) of the forked collection from which to create the pull request. Format: {owner}-{collectionId} | | `destination_id` | string | Yes | The UID of the destination (parent) collection where the changes will be merged. Format: {owner}-{collectionId} | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Request in Collection **Slug:** `POSTMAN_CREATE_A_REQUEST` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the request to create | | `request` | object | Yes | The request object containing method, URL, headers, body, and other request details following the Postman Collection Format | | `collection_id` | string | Yes | The unique identifier of the collection where the request will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Request Comment **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The comment text content to post on the request. | | `thread_id` | integer | No | Optional thread ID to reply to an existing comment. If provided, this comment will be added as a reply to the specified thread. | | `request_uid` | string | Yes | The request's unique ID (UID). This identifies the specific request to create a comment on. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Response **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | The response body as a string | | `code` | integer | No | The HTTP status code | | `name` | string | Yes | The name of the response example | | `header` | array | No | Array of header objects with key and value properties | | `status` | string | No | The status text (e.g., OK, Not Found, Bad Request) | | `collection_id` | string | Yes | The unique identifier of the collection where the response will be created | | `original_request` | object | No | The original request object structure. | | `parent_request_id` | string | Yes | The unique identifier of the parent request to which this response will be attached | | `_postman_previewlanguage` | string | No | The preview language for the response body (e.g., json, html, xml) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Response Comment **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The comment text content to post on the response. | | `thread_id` | integer | No | Optional thread ID to reply to an existing comment. If provided, this comment will be added as a reply to the specified thread. | | `response_uid` | string | Yes | The response's unique ID (UID). This identifies the specific response to create a comment on. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create API Schema **Slug:** `POSTMAN_CREATE_A_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 consist of single or multiple files. Returns the created schema's ID and metadata upon successful creation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | The type of schema being created. Common values include 'openapi:3' (OpenAPI 3.0), 'openapi:2' (Swagger 2.0), 'proto' (Protocol Buffers), 'graphql', etc. | | `files` | array | Yes | 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 | | `api_id` | string | Yes | The unique identifier (UUID) of the API for which to create the schema | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Mock Server Response **Slug:** `POSTMAN_CREATE_A_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock_id` | string | Yes | The unique identifier of the mock server (UUID format) | | `serverResponse` | object | Yes | Server response configuration containing name, status code, and optional body/headers | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Spec **Slug:** `POSTMAN_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 OpenAPI 3.0, OpenAPI 3.1, and AsyncAPI 2.0. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the API specification to create | | `type` | string | Yes | The type of specification. Common values include 'OPENAPI:3.0', 'OPENAPI:3.1', 'ASYNCAPI:2.0' | | `files` | array | Yes | 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 | | `workspace_id` | string | Yes | The workspace ID where the spec will be created. This is a UUID format string identifying the target workspace | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Spec File **Slug:** `POSTMAN_CREATE_A_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `path` | string | Yes | The file path within the spec (e.g., 'components/schemas.yaml', 'paths/users.yaml'). This defines the file location in the spec structure | | `content` | string | Yes | The content of the file to create. Must be a valid YAML or JSON string | | `spec_id` | string | Yes | The unique identifier of the API specification in which to create the file | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Webhook **Slug:** `POSTMAN_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 URL is available in the webhookUrl property of the response. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook` | object | Yes | Webhook configuration object containing name and collection UID | | `workspace` | string | Yes | The workspace ID where the webhook will be created | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a Workspace **Slug:** `POSTMAN_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. Returns the created workspace's ID, name, and type upon successful creation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | object | Yes | The workspace object containing name, type, and optional description | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create or Update a Schema File **Slug:** `POSTMAN_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, file path, and stringified JSON content. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API containing the schema. This is the API's ID in Postman. | | `content` | string | Yes | 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. | | `file_path` | string | Yes | 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'). | | `schema_id` | string | Yes | The unique identifier of the schema to which the file belongs. This is the schema's ID within the API. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create API Version Relations **Slug:** `POSTMAN_CREATE_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock` | array | No | Array of mock server UIDs | | `api_id` | string | Yes | The unique identifier of the API | | `testsuite` | array | No | Array of collection UIDs for test suites | | `contracttest` | array | No | Array of collection UIDs for contract testing | | `documentation` | array | No | Array of collection UIDs for documentation | | `api_version_id` | string | Yes | The unique identifier of the API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Collection **Slug:** `POSTMAN_DELETE_A_COLLECTION` Tool to permanently delete a collection from Postman. Use when you need to remove a collection that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_id` | string | Yes | The unique identifier (UID) or ID of the collection to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a collection's comment **Slug:** `POSTMAN_DELETE_A_COLLECTIONS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API's ID | | `comment_id` | integer | Yes | The comment's ID | | `collection_id` | string | Yes | The collection's UID | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Folder **Slug:** `POSTMAN_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 errors. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | 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. | | `collection_id` | string | Yes | The collection's ID. This is the unique identifier for the collection containing the folder to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Folder's Comment **Slug:** `POSTMAN_DELETE_A_FOLDERS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment_id` | integer | Yes | The ID of the comment to delete | | `folder_uid` | string | Yes | The unique identifier (UID) of the folder | | `collection_uid` | string | Yes | The unique identifier (UID) of the collection | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an API **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The ID of the API to delete. This is the unique identifier for the API. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an API's Comment **Slug:** `POSTMAN_DELETE_AN_APIS_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 was successfully deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API ID. This is the unique identifier of the API from which to delete the comment | | `comment_id` | string | Yes | The comment ID. This is the unique identifier of the comment to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete an environment **Slug:** `POSTMAN_DELETE_AN_ENVIRONMENT` Tool to delete an environment permanently in Postman. Use when you need to remove an environment that is no longer needed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `environment_id` | string | Yes | The environment ID or UID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Request's Comment **Slug:** `POSTMAN_DELETE_A_REQUESTS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment_id` | integer | Yes | The comment's ID to delete. This identifies the specific comment to be removed. | | `request_uid` | string | Yes | The request's unique ID (UID). This identifies the specific request containing the comment. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Response **Slug:** `POSTMAN_DELETE_A_RESPONSE` Tool to delete a response in a Postman collection. Use when you need to remove a saved response from a collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `response_id` | string | Yes | The unique identifier of the response to delete | | `collection_id` | string | Yes | The unique identifier of the collection containing the response | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Response's Comment **Slug:** `POSTMAN_DELETE_A_RESPONSES_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment_id` | integer | Yes | The unique identifier for the comment to delete. | | `response_uid` | string | Yes | The unique identifier for the response. | | `collection_uid` | string | Yes | The unique identifier for the collection. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Schema File **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API's ID. This is the unique identifier for the API containing the schema. | | `file_path` | string | Yes | The path to the schema file to delete. This is the file path within the schema. | | `schema_id` | string | Yes | The schema's ID. This is the unique identifier for the schema containing the file. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Mock Server Response **Slug:** `POSTMAN_DELETE_A_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock_id` | string | Yes | The mock server's unique identifier (UUID format) | | `server_response_id` | string | Yes | The server response's unique identifier (UUID format) to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Spec **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The ID of the API specification to delete. This is the unique identifier for the specification. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Spec File **Slug:** `POSTMAN_DELETE_A_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The unique identifier of the API specification containing the file to delete | | `file_path` | string | Yes | The path to the file within the specification to delete (e.g., 'components/schemas.yaml', 'openapi.yaml') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a Workspace **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | The ID of the workspace to delete. This is the unique identifier assigned to the workspace when it was created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Monitor **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `monitor_id` | string | Yes | The ID of the monitor to delete | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Duplicate a Collection **Slug:** `POSTMAN_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 be tracked using the duplication task status endpoint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | Yes | The ID of the workspace where the duplicated collection will be created | | `collection_id` | string | Yes | The unique identifier (UUID) of the collection to duplicate | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fork Collection **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `label` | string | No | Label or name for the fork. If not provided, the fork will be created with a default label. | | `workspace` | string | Yes | The workspace ID where the forked collection will be created. This is a required parameter for creating a fork. | | `collection_id` | string | Yes | The unique identifier (UUID) of the collection to fork | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Collection from Spec **Slug:** `POSTMAN_GENERATE_A_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 asynchronous and returns a task ID and polling URL to check the generation status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name for the generated collection. This will be the display name in Postman. | | `options` | object | No | Options for configuring the collection generation from the specification. | | `spec_id` | string | Yes | The unique identifier of the API specification from which to generate the collection. | | `element_type` | string | No | The type of element to generate. Must be 'collection' for collection generation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Spec from Collection **Slug:** `POSTMAN_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 asynchronous and returns a task ID and polling URL to check the generation status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name for the generated API specification. This will be used to identify the generated spec. | | `type` | string | Yes | The specification type to generate. Must be 'OPENAPI:3.0' for OpenAPI 3.0 specification format. | | `format` | string ("json" | "yaml") | Yes | The format of the generated specification file. Choose 'json' for JSON format or 'yaml' for YAML format. | | `element_type` | string | No | The type of element to generate. Valid value is 'spec' for API specification generation. | | `collection_uid` | string | Yes | The unique identifier for the collection (UID format). This identifies the collection to generate the specification from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Billing Account Details **Slug:** `POSTMAN_GET_ACCOUNTS` 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 slots, sales channel, or billing email. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Comments **Slug:** `POSTMAN_GET_A_COLLECTIONS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API's unique identifier (UUID). This identifies the API containing the collection. | | `collection_id` | string | Yes | The collection's unique identifier (UUID). This identifies the specific collection to retrieve comments from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection's Forks **Slug:** `POSTMAN_GET_A_COLLECTIONS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_id` | string | Yes | The unique identifier (UUID) of the collection whose forks you want to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Pull Requests **Slug:** `POSTMAN_GET_A_COLLECTIONS_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 specific collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_uid` | string | Yes | The unique identifier for the collection in the format {owner}-{collectionId}. This identifies the collection to retrieve pull requests from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Roles **Slug:** `POSTMAN_GET_A_COLLECTIONS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_id` | string | Yes | The unique identifier of the collection to retrieve roles for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Folder Information **Slug:** `POSTMAN_GET_A_FOLDER` 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 timestamps. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | The unique identifier of the folder to retrieve. Note: folder IDs should not contain spaces to avoid 404 errors. | | `collection_id` | string | Yes | The unique identifier of the collection containing the folder | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Folder Comments **Slug:** `POSTMAN_GET_A_FOLDERS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_uid` | string | Yes | The folder's unique ID (UID). This identifies the specific folder to retrieve comments from. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All API Releases **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API | | `api_version_id` | string | Yes | The unique identifier of the API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All APIs **Slug:** `POSTMAN_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 objects with their IDs, names, summaries, and other metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | No | Filter by workspace ID to get APIs specific to a workspace. If not provided, returns all APIs accessible to the authenticated user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Collections **Slug:** `POSTMAN_GET_ALL_COLLECTIONS2` Tool to get all collections accessible to the authenticated user. Use when you need to retrieve all your collections including subscribed collections. Returns detailed information for each collection including owner, creation/update timestamps, and visibility. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | No | Optional workspace ID to filter collections. Can be empty to get all collections across all workspaces. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Environments **Slug:** `POSTMAN_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 array of environment objects with their IDs, names, and UIDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | No | Filter by workspace ID to get environments specific to a workspace. If not provided, returns all environments accessible to the authenticated user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Forked Collections **Slug:** `POSTMAN_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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Groups **Slug:** `POSTMAN_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 with their IDs, names, team IDs, user counts, and creation/update timestamps. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Linked Relations **Slug:** `POSTMAN_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 API version. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API. This is the API's ID returned when listing or creating APIs. | | `api_version_id` | string | Yes | The unique identifier of the API version. This is the version ID returned when listing or creating API versions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Mock Servers **Slug:** `POSTMAN_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 you created across all workspaces. Can be filtered by workspace ID to get mock servers specific to a workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Monitors **Slug:** `POSTMAN_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 monitor objects with their IDs, names, and UIDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | string | No | Filter by workspace ID to get monitors specific to a workspace. If not provided, returns all monitors accessible to the authenticated user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All API Specifications **Slug:** `POSTMAN_GET_ALL_SPECS` 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 IDs, names, types, and timestamps, along with pagination metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | The workspace ID to fetch API specifications from. This is required to retrieve specs for a specific workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Team Users **Slug:** `POSTMAN_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 objects with their IDs, names, usernames, emails, roles, and join timestamps. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Test Relations **Slug:** `POSTMAN_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 Postman v10 and higher. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API. | | `api_version_id` | string | Yes | The unique identifier of the API version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All API Versions **Slug:** `POSTMAN_GET_ALL_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 their IDs and names. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API whose versions you want to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get All Workspaces **Slug:** `POSTMAN_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 workspace objects with their IDs, names, and types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("personal" | "team" | "public") | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Monitor Information **Slug:** `POSTMAN_GET_A_MONITOR` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `monitor_id` | string | Yes | The unique identifier of the monitor to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Information **Slug:** `POSTMAN_GET_AN_API` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Comments **Slug:** `POSTMAN_GET_AN_APIS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API's unique identifier (UUID). This identifies the API to retrieve comments from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Version **Slug:** `POSTMAN_GET_AN_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, name, creation date, and associated schemas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API. | | `api_version_id` | string | Yes | The unique identifier of the API version to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get an Environment **Slug:** `POSTMAN_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 variables. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `environment_id` | string | Yes | The unique identifier (ID or UID) of the environment to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Environment Forks **Slug:** `POSTMAN_GET_AN_ENVIRONMENTS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `environment_uid` | string | Yes | The environment's unique identifier (UID) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Request Information **Slug:** `POSTMAN_GET_A_REQUEST` 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, authentication, and associated scripts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `request_id` | string | Yes | The unique identifier of the request to retrieve | | `collection_id` | string | Yes | The unique identifier of the collection containing the request | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Request Comments **Slug:** `POSTMAN_GET_A_REQUESTS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `request_uid` | string | Yes | The request's unique ID (UID). This identifies the specific request to retrieve comments from. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Response Information **Slug:** `POSTMAN_GET_A_RESPONSE` 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 metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `response_id` | string | Yes | The unique identifier of the response to retrieve | | `collection_id` | string | Yes | The unique identifier of the collection containing the response | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Response Comments **Slug:** `POSTMAN_GET_A_RESPONSES_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `response_uid` | string | Yes | The response's unique ID (UID). This identifies the specific response to retrieve comments from. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Schema **Slug:** `POSTMAN_GET_A_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 published in a specific API version. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API's unique identifier | | `schema_id` | string | Yes | The schema's unique identifier | | `version_id` | string | No | Optional. The API version ID to get a schema published in a specific API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get API Specification **Slug:** `POSTMAN_GET_A_SPEC` Tool to retrieve information about an API specification in Postman. Use when you need to fetch spec details including name, type, and timestamps. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The unique identifier of the API specification to retrieve. This is a UUID format string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Spec File Contents **Slug:** `POSTMAN_GET_A_SPEC_FILE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The ID of the API specification | | `file_path` | string | Yes | The path of the file within the spec (e.g., 'openapi.yaml', 'components/schemas.yaml') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Spec Definition **Slug:** `POSTMAN_GET_A_SPECS_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 definition content as a string. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The unique identifier of the API specification to retrieve the definition for. This is a UUID format string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Specification Files **Slug:** `POSTMAN_GET_A_SPECS_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, names, paths, types, and timestamps. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The ID of the API specification whose files you want to retrieve. This is the unique identifier for the specification. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Spec's Generated Collections **Slug:** `POSTMAN_GET_A_SPECS_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 metadata and an array of generated collections. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The unique identifier of the API specification | | `element_type` | string | No | The type of element to retrieve generations for. Valid value: 'collection' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Async Collection Update Status **Slug:** `POSTMAN_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 completed successfully, or has failed. The task ID is obtained from PUT /collections/{collectionId} endpoint when using the Prefer: respond-async header. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `task_id` | string | Yes | The ID of the collection update task. Obtained from PUT /collections/{collectionId} with Prefer: respond-async header. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Team User **Slug:** `POSTMAN_GET_A_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | The ID of the user to retrieve information about | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Authenticated User **Slug:** `POSTMAN_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 address. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace Details **Slug:** `POSTMAN_GET_A_WORKSPACE` 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, APIs, mocks, and monitors. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | The unique identifier of the workspace to retrieve | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace Activity Feed **Slug:** `POSTMAN_GET_A_WORKSPACES_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 changes and user activity. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | The maximum number of activities to return. Used for pagination. | | `cursor` | string | No | Cursor for pagination. Use the nextCursor value from the previous response to fetch the next page of results. | | `workspace_id` | string | Yes | The ID of the workspace to get the activity feed for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace Roles **Slug:** `POSTMAN_GET_A_WORKSPACES_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 workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | The unique identifier of the workspace to retrieve roles for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Collection Access Keys **Slug:** `POSTMAN_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 key objects with their IDs, tokens, status, and associated collection information. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contract Test Relations **Slug:** `POSTMAN_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 limited or no data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API | | `api_version_id` | string | Yes | The unique identifier of the API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get documentation relations **Slug:** `POSTMAN_GET_DOCUMENTATION_RELATIONS` Tool to get documentation relations for a specific API version. This endpoint is deprecated in Postman v10 and higher. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The ID of the API | | `api_version_id` | string | Yes | The ID of the API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Duplication Task Status **Slug:** `POSTMAN_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. The task ID must first be obtained from the POST /collections/{collectionId}/duplicates endpoint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `task_id` | string | Yes | The ID of the collection duplication task. Obtained from POST /collections/{collectionId}/duplicates endpoint response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Environment Relations **Slug:** `POSTMAN_GET_ENVIRONMENT_RELATIONS` Tool to get environment relations for a specific API version. This endpoint is deprecated in Postman v10 and higher. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique ID of the API. | | `api_version_id` | string | Yes | The unique ID of the API version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Generated Specification **Slug:** `POSTMAN_GET_GENERATED_SPEC` 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. Returns metadata and an array of generated specifications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `element_type` | string | No | The type of generated element to retrieve. Use 'spec' for API specifications. This is typically 'spec' for OpenAPI/Swagger specifications generated from the collection. | | `collection_uid` | string | Yes | The unique identifier for the collection. This is the collection's UID (with team/user prefix). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace Global Variables **Slug:** `POSTMAN_GET_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, scripts, and environments. Note that this endpoint only works with personal or team workspaces, not public workspaces. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | The unique identifier of the workspace to retrieve global variables from. Can be obtained from the GET /workspaces endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Integration Test Relations **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API | | `api_version_id` | string | Yes | The unique identifier of the API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Resource Types **Slug:** `POSTMAN_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 corresponding endpoints and schemas. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Schema File Contents **Slug:** `POSTMAN_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 contents from a specific API version. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API's unique identifier | | `file_path` | string | Yes | The path of the file within the schema (e.g., 'index.yaml', 'schemas/openapi.yaml') | | `schema_id` | string | Yes | The schema's unique identifier | | `version_id` | string | No | Optional query parameter to get schema file contents published in an API version | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Schema Files **Slug:** `POSTMAN_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 files from a particular API version. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API containing the schema. | | `schema_id` | string | Yes | The unique identifier of the schema whose files you want to retrieve. | | `version_id` | string | No | Optional version ID to get schema files published in a specific API version. If not provided, returns files from the latest version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Service Provider Configuration **Slug:** `POSTMAN_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 endpoint returns configuration details including support for PATCH, bulk operations, filtering, sorting, and ETag handling. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Source Collection Status **Slug:** `POSTMAN_GET_SOURCE_COLLECTIONS_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 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_id` | string | Yes | The ID of a forked collection. The endpoint only works with forked collections, not regular collections. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Test Suite Relations **Slug:** `POSTMAN_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 only works with legacy v9 APIs. For v10+ APIs, this returns an empty array. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API to get test suite relations for. | | `api_version_id` | string | Yes | The unique identifier of the API version to get test suite relations for. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Unclassified Relations **Slug:** `POSTMAN_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 v10 and higher. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The API identifier (UUID format) | | `api_version_id` | string | Yes | The API version identifier (UUID format) | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import OpenAPI Specification **Slug:** `POSTMAN_IMPORT_OPENAPI` 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 workspace. The imported specification will be automatically converted to a Postman collection with all endpoints, request parameters, and documentation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string | Yes | 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'. | | `input` | string | Yes | 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'. | | `workspace` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Account Invoices **Slug:** `POSTMAN_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 from the GET /accounts endpoint. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string | No | Filter invoices by status (e.g., PAID). If not provided, returns all invoices. | | `account_id` | string | Yes | The billing account ID obtained from GET /accounts endpoint | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Merge a Fork **Slug:** `POSTMAN_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 collection. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source` | string | Yes | The UID of the forked collection (source) to merge from | | `strategy` | string | No | Optional merge strategy: 'deleteSource' (merge and delete forked collection) or 'updateSourceWithDestination' (merge and update both collections) | | `destination` | string | Yes | The UID of the parent collection (destination) to merge into | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Merge a forked environment **Slug:** `POSTMAN_MERGE_A_FORK2` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source` | string | Yes | The UID of the forked (source) environment to merge from | | `environment_uid` | string | Yes | The UID of the parent (destination) environment where changes will be merged into | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Publish a Mock Server **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock_id` | string | Yes | The unique identifier of the mock server to publish. Publishing a mock server sets its Access Control configuration to public. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Pull Source Changes into Fork **Slug:** `POSTMAN_PULL_SOURCE_CHANGES2` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_id` | string | Yes | The ID of the forked collection that will receive the changes from its parent (source) collection | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Replace an Environment's Data **Slug:** `POSTMAN_REPLACE_AN_ENVIRONMENTS_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 replaces ALL existing variables with the ones provided in the request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `environment` | object | Yes | Environment object containing name and array of environment variables. This completely replaces the environment's data | | `environment_id` | string | Yes | The unique identifier (ID or UID) of the environment to replace | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Replace Collection Data Asynchronously **Slug:** `POSTMAN_REPLACE_COLLECTIONS_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 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection` | object | Yes | 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. | | `collection_id` | string | Yes | The unique identifier (ID or UID) of the collection to replace | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve a Comment Thread **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `thread_id` | integer | Yes | The ID of the comment thread to resolve. This is obtained from the threadId field when creating or retrieving comments. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Review a Pull Request **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action` | string ("approve" | "decline" | "unapprove") | Yes | 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 | | `pull_request_id` | string | Yes | The unique identifier of the pull request to review | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Run a Monitor **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `monitor_id` | string | Yes | The unique identifier (ID or UID) of the monitor to run | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Sync Collection with API Schema **Slug:** `POSTMAN_SYNC_COLLECTION_WITH_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 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api_id` | string | Yes | The unique identifier of the API. Must be in UUID format. | | `collection_uid` | string | Yes | The unique identifier of the collection that is attached to the API. Format: userId-collectionId. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Sync Collection with Specification **Slug:** `POSTMAN_SYNC_COLLECTION_WITH_SPEC` 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 the latest version of its source API specification. The collection must have been generated from a spec. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The ID of the API specification to sync with the collection. This is the source specification that the collection was generated from. | | `collection_uid` | string | Yes | The UID of a collection that was generated from an API specification. This collection will be synchronized with its source specification. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Sync Spec with Collection **Slug:** `POSTMAN_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 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `spec_id` | string | Yes | The unique identifier of the API specification to sync. Must be in UUID format. | | `collection_uid` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Transfer Folders **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | Yes | 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. | | `mode` | string ("copy" | "move") | Yes | Transfer mode: 'copy' creates duplicates of folders in target, 'move' relocates folders to target (removes from source). | | `target` | object | Yes | Target location where folders should be transferred. Specify the model type (collection or folder) and its UID. | | `location` | object | Yes | Position within the target where folders should be placed. Specify 'start' or 'end' for the position. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Transform Collection to OpenAPI **Slug:** `POSTMAN_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 interoperability with other tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection_id` | string | Yes | The unique identifier of the collection to transform into OpenAPI format | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Folder **Slug:** `POSTMAN_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 Postman Collection Format documentation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The new name for the folder | | `folder_id` | string | Yes | The unique identifier of the folder to update | | `description` | string | No | Optional updated description for the folder explaining its purpose | | `collection_id` | string | Yes | The unique identifier of the collection containing the folder | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Folder's Comment **Slug:** `POSTMAN_UPDATE_A_FOLDERS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The updated text content of the comment. | | `comment_id` | string | Yes | The unique identifier of the comment to update. | | `folder_uid` | string | Yes | The unique identifier (UID) of the folder containing the comment. | | `collection_uid` | string | Yes | The unique identifier (UID) of the collection containing the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Mock Server **Slug:** `POSTMAN_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 updates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock` | object | Yes | Mock server configuration containing the collection UID (required), and optional name, environment UID, and privacy setting | | `mock_id` | string | Yes | The unique identifier of the mock server to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Monitor **Slug:** `POSTMAN_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 distribution settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `monitor` | object | Yes | The monitor object containing fields to update. All fields are optional - only include fields you want to update. | | `monitor_id` | string | Yes | The unique identifier (ID or UID) of the monitor to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an API **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `api` | object | Yes | The API object containing fields to update. Include at least one of: name, summary, or description. | | `api_id` | string | Yes | The unique identifier of the API to update. This is the API ID returned when the API was created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an API's Comment **Slug:** `POSTMAN_UPDATE_AN_APIS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The updated text content of the comment. | | `api_id` | string | Yes | The API's unique identifier. This identifies the API containing the comment to update. | | `comment_id` | integer | Yes | The comment's unique identifier. This is the ID of the comment to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update an Environment **Slug:** `POSTMAN_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 environment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `operations` | array | Yes | Array of JSON Patch operations to apply to the environment. Each operation modifies a specific field using the RFC 6902 format | | `environment_id` | string | Yes | The unique identifier (ID or UID) of the environment to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Pull Request **Slug:** `POSTMAN_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 be provided in the request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | Yes | The updated title of the pull request. This should summarize the changes being proposed. | | `reviewers` | array | Yes | 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. | | `source_id` | string | Yes | The UID of the source collection (forked collection). Format: {owner}-{collectionId}. This field is required even when updating a pull request. | | `description` | string | Yes | The updated description for the pull request. Provides context for reviewers about the changes. | | `destination_id` | string | Yes | The UID of the destination collection (parent collection). Format: {owner}-{collectionId}. This field is required even when updating a pull request. | | `pull_request_id` | string | Yes | The unique identifier of the pull request to update. This is the pull request ID returned when the pull request was created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Request in Collection **Slug:** `POSTMAN_UPDATE_A_REQUEST` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The updated name of the request | | `request` | object | No | Request object following Postman Collection Format. | | `request_id` | string | Yes | The unique identifier of the request to update | | `collection_id` | string | Yes | The unique identifier of the collection containing the request | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Request's Comment **Slug:** `POSTMAN_UPDATE_A_REQUESTS_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The updated text content of the comment. | | `comment_id` | integer | Yes | The comment's unique identifier. This is the ID of the comment to update. | | `request_uid` | string | Yes | The request's unique ID (UID). This identifies the specific request containing the comment. | | `collection_uid` | string | Yes | The collection's unique ID (UID). This identifies the collection containing the request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Response **Slug:** `POSTMAN_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 body. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `response` | object | Yes | The response object containing the properties to update. Can include name, status, code, header, cookie, body, originalRequest, etc. | | `response_id` | string | Yes | The unique identifier of the response to update | | `collection_id` | string | Yes | The unique identifier of the collection containing the response | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Response's Comment **Slug:** `POSTMAN_UPDATE_A_RESPONSES_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | The updated text content of the comment. | | `comment_id` | string | Yes | The unique identifier of the comment to update. | | `response_uid` | string | Yes | The unique identifier (UID) of the response containing the comment. | | `collection_uid` | string | Yes | The unique identifier (UID) of the collection containing the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Server Response **Slug:** `POSTMAN_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 least one property must be included in the update request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mock_id` | string | Yes | The mock server's unique identifier (UUID format) | | `server_response` | object | Yes | The server response object containing the properties to update. Include at least one property: name, status_code, language, body, or headers. | | `server_response_id` | string | Yes | The server response's unique identifier (UUID format) to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Spec File **Slug:** `POSTMAN_UPDATE_A_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `content` | string | Yes | The updated content of the spec file in YAML or JSON format | | `spec_id` | string | Yes | The unique identifier of the API specification | | `file_path` | string | Yes | The path of the file within the spec to update (e.g., 'openapi.yaml', 'components/schemas.yaml') | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Spec Properties **Slug:** `POSTMAN_UPDATE_A_SPECS_PROPERTIES` Tool to update an API specification's properties such as its name. Use when you need to modify metadata of an existing spec. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The new name for the API specification | | `spec_id` | string | Yes | The unique identifier of the API specification to update. This is a UUID format string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a Workspace **Slug:** `POSTMAN_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace` | object | Yes | The workspace object containing fields to update. The 'type' field is required, while 'name' and 'description' are optional. | | `workspace_id` | string | Yes | The unique identifier of the workspace to update. This is the workspace ID returned when the workspace was created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workspace Global Variables **Slug:** `POSTMAN_UPDATE_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 global variables with the provided list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `values` | array | Yes | Array of global variable objects to set. This replaces all existing global variables in the workspace with the provided list. | | `workspace_id` | string | Yes | The unique identifier of the workspace to update global variables for. Can be obtained from the GET /workspaces endpoint. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Collection Properties **Slug:** `POSTMAN_UPDATE_PART_OF_A_COLLECTION` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `collection` | object | Yes | 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. | | `collection_id` | string | Yes | The unique identifier (ID or UID) of the collection to update | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |