Postman

postman

Postman is an API platform for building, testing, and managing APIs with powerful collaboration features.

Developer Tools Web del proveedor

Acciones

146

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (146)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create a CollectionPOSTMAN_CREATE_A_COLLECTIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a Collection CommentPOSTMAN_CREATE_A_COLLECTION_COMMENTAcción

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.

Parámetros de entrada

bodystringObligatorio
The text content of the comment to create on the API collection.
api_idstringObligatorio
The API's unique identifier (UUID). This identifies the API containing the collection.
thread_idany
Optional thread ID to reply to an existing comment thread. Include this to create a reply on an existing comment.
collection_idstringObligatorio
The collection's unique identifier (UUID). This identifies the specific collection to comment on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Collection from SchemaPOSTMAN_CREATE_A_COLLECTION_FROM_A_SCHEMAAcción

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.

Parámetros de entrada

namestringObligatorio
The name of the collection to be created
api_idstringObligatorio
The unique identifier (UUID) of the API
relationsobject[]Obligatorio
List of relation(s) to be created. Each relation must specify a type from the allowed values
schema_idstringObligatorio
The unique identifier (UUID) of the schema from which to create the collection
workspaceany
Optional workspace ID where the collection will be created. If not specified, the collection is created in the user's default workspace
api_version_idstringObligatorio
The unique identifier (UUID) of the API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a FolderPOSTMAN_CREATE_A_FOLDERAcción

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.

Parámetros de entrada

namestringObligatorio
The name of the folder to create
descriptionany
Optional description of the folder explaining its purpose
collection_idstringObligatorio
The unique identifier of the collection to create the folder in

Parámetros de salida

dataany
Data about the created folder
metaany
Metadata about the folder creation operation
errorany
Error if any occurred during the execution of the action
model_idany
The model ID of the created folder
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a Folder CommentPOSTMAN_CREATE_A_FOLDER_COMMENTAcción

Tool to create a comment on a folder. Use when you need to add a comment to a specific folder in a collection.

Parámetros de entrada

bodystringObligatorio
The comment text content to post on the folder.
folder_uidstringObligatorio
The unique identifier (UID) of the folder to comment on.
collection_uidstringObligatorio
The unique identifier (UID) of the collection containing the folder.

Parámetros de salida

dataany
The created comment object with all its details
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a ForkPOSTMAN_CREATE_A_FORKAcción

Tool to create a fork from an existing collection into a workspace. Use when you need to fork a collection to create an independent copy in a specific workspace.

Parámetros de entrada

labelstringObligatorio
A label or name for the fork. This describes the purpose of this fork.
workspacestringObligatorio
The workspace ID where the forked collection will be created
collection_idstringObligatorio
The unique identifier (UUID) of the collection to fork

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Environment ForkPOSTMAN_CREATE_A_FORK2Acción

Tool to create a fork from an existing environment into a workspace. Use when you need to fork an environment to a specified workspace.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a Mock ServerPOSTMAN_CREATE_A_MOCK_SERVERAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a MonitorPOSTMAN_CREATE_A_MONITORAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an APIPOSTMAN_CREATE_AN_APIAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an APIPOSTMAN_CREATE_AN_API2Acción

Tool to create a new API in a Postman workspace. Use when you need to create an API with a name and optional summary and description.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an EnvironmentPOSTMAN_CREATE_AN_ENVIRONMENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a Pull RequestPOSTMAN_CREATE_A_PULL_REQUESTAcción

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.

Parámetros de entrada

titlestringObligatorio
The title of the pull request. This should summarize the changes being proposed.
reviewersstring[]
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.
descriptionany
A detailed description of the changes in the pull request. Provides context for reviewers.
collection_uidstringObligatorio
The unique identifier (UID) of the forked collection from which to create the pull request. Format: {owner}-{collectionId}
destination_idstringObligatorio
The UID of the destination (parent) collection where the changes will be merged. Format: {owner}-{collectionId}

Parámetros de salida

dataany
The pull request object containing details about the created pull request
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Request in CollectionPOSTMAN_CREATE_A_REQUESTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
Data about the created request
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a Request CommentPOSTMAN_CREATE_A_REQUEST_COMMENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
The created comment object with all its details
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a ResponsePOSTMAN_CREATE_A_RESPONSEAcción

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.

Parámetros de entrada

bodyany
The response body as a string
codeany
The HTTP status code
namestringObligatorio
The name of the response example
headerany
Array of header objects with key and value properties
statusany
The status text (e.g., OK, Not Found, Bad Request)
collection_idstringObligatorio
The unique identifier of the collection where the response will be created
original_requestany
The original request object containing method and url
parent_request_idstringObligatorio
The unique identifier of the parent request to which this response will be attached
_postman_previewlanguageany
The preview language for the response body (e.g., json, html, xml)

Parámetros de salida

dataany
Data about the created response
metaany
Metadata about the response operation
errorany
Error if any occurred during the execution of the action
model_idany
The model ID of the response
revisionany
The revision number of the collection after creation
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a Response CommentPOSTMAN_CREATE_A_RESPONSE_COMMENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
The created comment object with all its details
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create API SchemaPOSTMAN_CREATE_A_SCHEMAAcción

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.

Parámetros de entrada

typestringObligatorio
The type of schema being created. Common values include 'openapi:3' (OpenAPI 3.0), 'openapi:2' (Swagger 2.0), 'proto' (Protocol Buffers), 'graphql', etc.
filesobject[]Obligatorio
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_idstringObligatorio
The unique identifier (UUID) of the API for which to create the schema

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Mock Server ResponsePOSTMAN_CREATE_A_SERVER_RESPONSEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a SpecPOSTMAN_CREATE_A_SPECAcción

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.

Parámetros de entrada

namestringObligatorio
The name of the API specification to create
typestringObligatorio
The type of specification. Common values include 'OPENAPI:3.0', 'OPENAPI:3.1', 'ASYNCAPI:2.0'
filesobject[]Obligatorio
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_idstringObligatorio
The workspace ID where the spec will be created. This is a UUID format string identifying the target workspace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Spec FilePOSTMAN_CREATE_A_SPEC_FILEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a WebhookPOSTMAN_CREATE_A_WEBHOOKAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a WorkspacePOSTMAN_CREATE_A_WORKSPACEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CollectionPOSTMAN_CREATE_COLLECTIONAcción

Tool to create a new Postman collection with specified name and configuration. Use when you need to create a new collection in Postman workspace. Returns the created collection's ID, name, and UID upon successful creation.

Parámetros de entrada

collectionobjectObligatorio
Collection object containing info (name, description, schema) and item array (requests/folders)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create EnvironmentPOSTMAN_CREATE_ENVIRONMENTAcción

Tool to create a new Postman environment with specified name and variables. Use when you need to create a new environment in Postman workspace. Returns the created environment's ID, name, and UID upon successful creation.

Parámetros de entrada

environmentobjectObligatorio
Environment object containing name and values array (variables)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Mock ServerPOSTMAN_CREATE_MOCKAcción

Tool to create a new mock server for a Postman collection. Use when you need to set up a mock server that simulates API responses based on saved examples in a collection.

Parámetros de entrada

mockobjectObligatorio
Mock server configuration object containing name, collection, and optional environment and private settings

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create MonitorPOSTMAN_CREATE_MONITORAcción

Tool to create a new monitor to run a collection on a schedule. Use when you need to set up automated collection runs at specified intervals using cron expressions.

Parámetros de entrada

monitorobjectObligatorio
Monitor configuration object containing name, collection, schedule, and optional environment

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or Update a Schema FilePOSTMAN_CREATE_OR_UPDATE_A_SCHEMA_FILEAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API containing the schema. This is the API's ID in Postman.
contentstringObligatorio
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_pathstringObligatorio
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_idstringObligatorio
The unique identifier of the schema to which the file belongs. This is the schema's ID within the API.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create API Version RelationsPOSTMAN_CREATE_RELATIONSAcción

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.

Parámetros de entrada

mockany
Array of mock server UIDs
api_idstringObligatorio
The unique identifier of the API
testsuiteany
Array of collection UIDs for test suites
contracttestany
Array of collection UIDs for contract testing
documentationany
Array of collection UIDs for documentation
api_version_idstringObligatorio
The unique identifier of the API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookPOSTMAN_CREATE_WEBHOOKAcción

Tool to create a new webhook for a Postman collection. Use when you need to create a webhook that triggers a collection when called. Returns the created webhook's ID and name upon successful creation.

Parámetros de entrada

webhookobjectObligatorio
Webhook object containing name and collection UID

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a CollectionPOSTMAN_DELETE_A_COLLECTIONAcción

Tool to permanently delete a collection from Postman. Use when you need to remove a collection that is no longer needed.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a collection's commentPOSTMAN_DELETE_A_COLLECTIONS_COMMENTAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API's ID
comment_idintegerObligatorio
The comment's ID
collection_idstringObligatorio
The collection's UID

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a FolderPOSTMAN_DELETE_A_FOLDERAcción

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.

Parámetros de entrada

folder_idstringObligatorio
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_idstringObligatorio
The collection's ID. This is the unique identifier for the collection containing the folder to delete.

Parámetros de salida

dataany
Data information about the deleted folder
metaany
Metadata about the delete operation
errorany
Error if any occurred during the execution of the action
model_idany
The ID of the deleted folder
revisionany
The revision number after the delete operation
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a Folder's CommentPOSTMAN_DELETE_A_FOLDERS_COMMENTAcción

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.

Parámetros de entrada

comment_idintegerObligatorio
The ID of the comment to delete
folder_uidstringObligatorio
The unique identifier (UID) of the folder
collection_uidstringObligatorio
The unique identifier (UID) of the collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an APIPOSTMAN_DELETE_AN_APIAcción

Tool to delete an API from Postman. Use when you need to permanently remove an API. On success, returns HTTP 204 No Content response.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an API's CommentPOSTMAN_DELETE_AN_APIS_COMMENTAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API ID. This is the unique identifier of the API from which to delete the comment
comment_idstringObligatorio
The comment ID. This is the unique identifier of the comment to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an environmentPOSTMAN_DELETE_AN_ENVIRONMENTAcción

Tool to delete an environment permanently in Postman. Use when you need to remove an environment that is no longer needed.

Parámetros de entrada

environment_idstringObligatorio
The environment ID or UID to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a Request's CommentPOSTMAN_DELETE_A_REQUESTS_COMMENTAcción

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.

Parámetros de entrada

comment_idintegerObligatorio
The comment's ID to delete. This identifies the specific comment to be removed.
request_uidstringObligatorio
The request's unique ID (UID). This identifies the specific request containing the comment.
collection_uidstringObligatorio
The collection's unique ID (UID). This identifies the collection containing the request.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a ResponsePOSTMAN_DELETE_A_RESPONSEAcción

Tool to delete a response in a Postman collection. Use when you need to remove a saved response from a collection.

Parámetros de entrada

response_idstringObligatorio
The unique identifier of the response to delete
collection_idstringObligatorio
The unique identifier of the collection containing the response

Parámetros de salida

dataany
Data about the deleted response
metaany
Metadata about the deletion operation
errorany
Error if any occurred during the execution of the action
model_idany
The ID of the deleted response model
revisionany
The revision number after deletion
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a Response's CommentPOSTMAN_DELETE_A_RESPONSES_COMMENTAcción

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.

Parámetros de entrada

comment_idintegerObligatorio
The unique identifier for the comment to delete.
response_uidstringObligatorio
The unique identifier for the response.
collection_uidstringObligatorio
The unique identifier for the collection.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a Schema FilePOSTMAN_DELETE_A_SCHEMA_FILEAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API's ID. This is the unique identifier for the API containing the schema.
file_pathstringObligatorio
The path to the schema file to delete. This is the file path within the schema.
schema_idstringObligatorio
The schema's ID. This is the unique identifier for the schema containing the file.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Mock Server ResponsePOSTMAN_DELETE_A_SERVER_RESPONSEAcción

Tool to delete a mock server's server response. Use when you need to remove a specific response from a Postman mock server.

Parámetros de entrada

mock_idstringObligatorio
The mock server's unique identifier (UUID format)
server_response_idstringObligatorio
The server response's unique identifier (UUID format) to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a SpecPOSTMAN_DELETE_A_SPECAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Spec FilePOSTMAN_DELETE_A_SPEC_FILEAcción

Tool to delete a file from an API specification. Use when you need to remove a specific file from a multi-file specification.

Parámetros de entrada

spec_idstringObligatorio
The unique identifier of the API specification containing the file to delete
file_pathstringObligatorio
The path to the file within the specification to delete (e.g., 'components/schemas.yaml', 'openapi.yaml')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a WorkspacePOSTMAN_DELETE_A_WORKSPACEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete MonitorPOSTMAN_DELETE_MONITORAcción

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.

Parámetros de entrada

monitor_idstringObligatorio
The ID of the monitor to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Duplicate a CollectionPOSTMAN_DUPLICATE_A_COLLECTIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fork CollectionPOSTMAN_FORK_COLLECTIONAcción

Tool to create a fork of a collection in a specified workspace. Use when you need to fork an existing collection to a workspace.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Collection from SpecPOSTMAN_GENERATE_A_COLLECTION_FROM_SPECAcción

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.

Parámetros de entrada

namestringObligatorio
The name for the generated collection. This will be the display name in Postman.
optionsany
Optional configuration settings to control how the collection is generated from the specification. If not provided, default settings are used.
spec_idstringObligatorio
The unique identifier of the API specification from which to generate the collection.
element_typestring
The type of element to generate. Must be 'collection' for collection generation.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate Spec from CollectionPOSTMAN_GENERATE_SPEC_FROM_COLLECTIONAcción

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.

Parámetros de entrada

namestringObligatorio
The name for the generated API specification. This will be used to identify the generated spec.
typestringObligatorio
The specification type to generate. Must be 'OPENAPI:3.0' for OpenAPI 3.0 specification format.
formatstringObligatorioenum
The format of the generated specification file. Choose 'json' for JSON format or 'yaml' for YAML format.
jsonyaml
element_typestring
The type of element to generate. Valid value is 'spec' for API specification generation.
collection_uidstringObligatorio
The unique identifier for the collection (UID format). This identifies the collection to generate the specification from.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Billing Account DetailsPOSTMAN_GET_ACCOUNTSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection CommentsPOSTMAN_GET_A_COLLECTIONS_COMMENTSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API's unique identifier (UUID). This identifies the API containing the collection.
collection_idstringObligatorio
The collection's unique identifier (UUID). This identifies the specific collection to retrieve comments from.

Parámetros de salida

dataobject[]
Array of comment objects left by users in the collection
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection's ForksPOSTMAN_GET_A_COLLECTIONS_FORKSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
Array of fork objects, each containing fork ID, user who forked it, and creation date
metaany
Metadata about the response including total count and pagination cursor
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection Pull RequestsPOSTMAN_GET_A_COLLECTIONS_PULL_REQUESTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]
Array of pull request objects for the collection, containing source and destination IDs, status, and URLs
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection RolesPOSTMAN_GET_A_COLLECTIONS_ROLESAcción

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.

Parámetros de entrada

collection_idstringObligatorio
The unique identifier of the collection to retrieve roles for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Folder InformationPOSTMAN_GET_A_FOLDERAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
Data about the folder
metaany
Metadata about the folder operation
errorany
Error if any occurred during the execution of the action
model_idany
The model ID of the folder
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Folder CommentsPOSTMAN_GET_A_FOLDERS_COMMENTSAcción

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.

Parámetros de entrada

folder_uidstringObligatorio
The folder's unique ID (UID). This identifies the specific folder to retrieve comments from.
collection_uidstringObligatorio
The collection's unique ID (UID). This identifies the collection containing the folder.

Parámetros de salida

dataobject[]
Array of comment objects left by users in the folder
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All API ReleasesPOSTMAN_GET_ALL_API_RELEASESAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API
api_version_idstringObligatorio
The unique identifier of the API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All APIsPOSTMAN_GET_ALL_APISAcción

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.

Parámetros de entrada

workspaceany
Filter by workspace ID to get APIs specific to a workspace. If not provided, returns all APIs accessible to the authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All APIs in WorkspacePOSTMAN_GET_ALL_APIS2Acción

Tool to get all APIs in a specific Postman workspace. Use when you need to list or retrieve APIs from a workspace. Returns an array of API objects with their details.

Parámetros de entrada

workspace_idstringObligatorio
The workspace ID to filter APIs by. Required to retrieve APIs from a specific workspace.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All CollectionsPOSTMAN_GET_ALL_COLLECTIONSAcción

Tool to get all collections accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve collections from Postman. Returns an array of collection objects with their IDs, names, and UIDs.

Parámetros de entrada

workspaceany
Filter by workspace ID to get collections specific to a workspace. If not provided, returns all collections accessible to the authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All CollectionsPOSTMAN_GET_ALL_COLLECTIONS2Acción

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.

Parámetros de entrada

workspaceany
Optional workspace ID to filter collections. Can be empty to get all collections across all workspaces.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All EnvironmentsPOSTMAN_GET_ALL_ENVIRONMENTSAcción

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.

Parámetros de entrada

workspaceany
Filter by workspace ID to get environments specific to a workspace. If not provided, returns all environments accessible to the authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Forked CollectionsPOSTMAN_GET_ALL_FORKED_COLLECTIONSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataany
Array of forked collection objects
metaany
Metadata about the response including total count and pagination cursor
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All GroupsPOSTMAN_GET_ALL_GROUPSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Linked RelationsPOSTMAN_GET_ALL_LINKED_RELATIONSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API. This is the API's ID returned when listing or creating APIs.
api_version_idstringObligatorio
The unique identifier of the API version. This is the version ID returned when listing or creating API versions.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Mock ServersPOSTMAN_GET_ALL_MOCK_SERVERSAcción

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.

Parámetros de entrada

workspaceany
Filter by workspace ID to get mock servers specific to a workspace. If not provided, returns all mock servers you created across all workspaces.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All MonitorsPOSTMAN_GET_ALL_MONITORSAcción

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.

Parámetros de entrada

workspaceany
Filter by workspace ID to get monitors specific to a workspace. If not provided, returns all monitors accessible to the authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Workspace RolesPOSTMAN_GET_ALL_ROLESAcción

Tool to get information about all roles in a workspace based on the team's plan. Use when you need to retrieve the IDs of all users with different roles (Editor, Admin, Viewer) in a workspace.

Parámetros de entrada

workspace_idstringObligatorio
The unique identifier of the workspace to retrieve roles for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All API SpecificationsPOSTMAN_GET_ALL_SPECSAcción

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.

Parámetros de entrada

workspace_idstringObligatorio
The workspace ID to fetch API specifications from. This is required to retrieve specs for a specific workspace.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Team UsersPOSTMAN_GET_ALL_TEAM_USERSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataany
Array of team user objects, each containing user details such as id, name, username, email, roles, and joinedAt timestamp
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All Test RelationsPOSTMAN_GET_ALL_TEST_RELATIONSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API.
api_version_idstringObligatorio
The unique identifier of the API version.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All API VersionsPOSTMAN_GET_ALL_VERSIONSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API whose versions you want to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All WorkspacesPOSTMAN_GET_ALL_WORKSPACESAcción

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.

Parámetros de entrada

typeany
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Monitor InformationPOSTMAN_GET_A_MONITORAcción

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.

Parámetros de entrada

monitor_idstringObligatorio
The unique identifier of the monitor to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API InformationPOSTMAN_GET_AN_APIAcción

Tool to retrieve information about a specific API in Postman. Use when you need to fetch API details including name, description, versions, and schemas.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API CommentsPOSTMAN_GET_AN_APIS_COMMENTSAcción

Tool to retrieve all comments left by users in an API. Use when you need to fetch all comments associated with a specific API.

Parámetros de entrada

api_idstringObligatorio
The API's unique identifier (UUID). This identifies the API to retrieve comments from.

Parámetros de salida

dataobject[]
Array of comment objects left by users in the API
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API VersionPOSTMAN_GET_AN_API_VERSIONAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API.
api_version_idstringObligatorio
The unique identifier of the API version to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get an EnvironmentPOSTMAN_GET_AN_ENVIRONMENTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Environment ForksPOSTMAN_GET_AN_ENVIRONMENTS_FORKSAcción

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.

Parámetros de entrada

environment_uidstringObligatorio
The environment's unique identifier (UID)

Parámetros de salida

dataany
Array of forked environment objects
metaany
Metadata about the response including total count and pagination cursor
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Request InformationPOSTMAN_GET_A_REQUESTAcción

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.

Parámetros de entrada

request_idstringObligatorio
The unique identifier of the request to retrieve
collection_idstringObligatorio
The unique identifier of the collection containing the request

Parámetros de salida

dataany
Data about the request
metaany
Metadata about the request operation
errorany
Error if any occurred during the execution of the action
model_idany
The model ID of the request
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Request CommentsPOSTMAN_GET_A_REQUESTS_COMMENTSAcción

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.

Parámetros de entrada

request_uidstringObligatorio
The request's unique ID (UID). This identifies the specific request to retrieve comments from.
collection_uidstringObligatorio
The collection's unique ID (UID). This identifies the collection containing the request.

Parámetros de salida

dataobject[]
Array of comment objects left by users in the request
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Response InformationPOSTMAN_GET_A_RESPONSEAcción

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.

Parámetros de entrada

response_idstringObligatorio
The unique identifier of the response to retrieve
collection_idstringObligatorio
The unique identifier of the collection containing the response

Parámetros de salida

dataany
Data about the response
metaany
Metadata about the response operation
errorany
Error if any occurred during the execution of the action
model_idany
The model ID of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Response CommentsPOSTMAN_GET_A_RESPONSES_COMMENTSAcción

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.

Parámetros de entrada

response_uidstringObligatorio
The response's unique ID (UID). This identifies the specific response to retrieve comments from.
collection_uidstringObligatorio
The collection's unique ID (UID). This identifies the collection containing the response.

Parámetros de salida

dataobject[]
Array of comment objects left by users in the response
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API SchemaPOSTMAN_GET_A_SCHEMAAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API's unique identifier
schema_idstringObligatorio
The schema's unique identifier
version_idany
Optional. The API version ID to get a schema published in a specific API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API SpecificationPOSTMAN_GET_A_SPECAcción

Tool to retrieve information about an API specification in Postman. Use when you need to fetch spec details including name, type, and timestamps.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Spec File ContentsPOSTMAN_GET_A_SPEC_FILEAcción

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.

Parámetros de entrada

spec_idstringObligatorio
The ID of the API specification
file_pathstringObligatorio
The path of the file within the spec (e.g., 'openapi.yaml', 'components/schemas.yaml')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Spec DefinitionPOSTMAN_GET_A_SPECS_DEFINITIONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Specification FilesPOSTMAN_GET_A_SPECS_FILESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Spec's Generated CollectionsPOSTMAN_GET_A_SPECS_GENERATED_COLLECTIONSAcción

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.

Parámetros de entrada

spec_idstringObligatorio
The unique identifier of the API specification
element_typestring
The type of element to retrieve generations for. Valid value: 'collection'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Async Collection Update StatusPOSTMAN_GET_ASYNC_COLLECTION_UPDATE_STATUSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Team UserPOSTMAN_GET_A_TEAM_USERAcción

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.

Parámetros de entrada

user_idintegerObligatorio
The ID of the user to retrieve information about

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Authenticated UserPOSTMAN_GET_AUTHENTICATED_USERAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workspace DetailsPOSTMAN_GET_A_WORKSPACEAcción

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.

Parámetros de entrada

workspace_idstringObligatorio
The unique identifier of the workspace to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workspace Activity FeedPOSTMAN_GET_A_WORKSPACES_ACTIVITY_FEEDAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
Array of activity objects showing workspace changes and user actions
metaany
Metadata containing pagination information
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workspace RolesPOSTMAN_GET_A_WORKSPACES_ROLESAcción

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.

Parámetros de entrada

workspace_idstringObligatorio
The unique identifier of the workspace to retrieve roles for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Collection Access KeysPOSTMAN_GET_COLLECTION_ACCESS_KEYSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataany
Array of collection access key objects
metaany
Pagination metadata including cursors for navigating results
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Contract Test RelationsPOSTMAN_GET_CONTRACT_TEST_RELATIONSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API
api_version_idstringObligatorio
The unique identifier of the API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get documentation relationsPOSTMAN_GET_DOCUMENTATION_RELATIONSAcción

Tool to get documentation relations for a specific API version. This endpoint is deprecated in Postman v10 and higher.

Parámetros de entrada

api_idstringObligatorio
The ID of the API
api_version_idstringObligatorio
The ID of the API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Duplication Task StatusPOSTMAN_GET_DUPLICATION_TASK_STATUSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Environment RelationsPOSTMAN_GET_ENVIRONMENT_RELATIONSAcción

Tool to get environment relations for a specific API version. This endpoint is deprecated in Postman v10 and higher.

Parámetros de entrada

api_idstringObligatorio
The unique ID of the API.
api_version_idstringObligatorio
The unique ID of the API version.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Generated SpecificationPOSTMAN_GET_GENERATED_SPECAcción

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.

Parámetros de entrada

element_typestring
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_uidstringObligatorio
The unique identifier for the collection. This is the collection's UID (with team/user prefix).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Workspace Global VariablesPOSTMAN_GET_GLOBAL_VARIABLESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Integration Test RelationsPOSTMAN_GET_INTEGRATION_TEST_RELATIONSAcción

Tool to get integration test relations for a specific API version. This endpoint is deprecated and may not return active data.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API
api_version_idstringObligatorio
The unique identifier of the API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource TypesPOSTMAN_GET_RESOURCE_TYPESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Schema File ContentsPOSTMAN_GET_SCHEMA_FILE_CONTENTSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API's unique identifier
file_pathstringObligatorio
The path of the file within the schema (e.g., 'index.yaml', 'schemas/openapi.yaml')
schema_idstringObligatorio
The schema's unique identifier
version_idany
Optional query parameter to get schema file contents published in an API version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Schema FilesPOSTMAN_GET_SCHEMA_FILESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Service Provider ConfigurationPOSTMAN_GET_SERVICE_PROVIDER_CONFIGURATIONAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Source Collection StatusPOSTMAN_GET_SOURCE_COLLECTIONS_STATUSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Test Suite RelationsPOSTMAN_GET_TEST_SUITE_RELATIONSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The unique identifier of the API to get test suite relations for.
api_version_idstringObligatorio
The unique identifier of the API version to get test suite relations for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Unclassified RelationsPOSTMAN_GET_UNCLASSIFIED_RELATIONSAcción

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.

Parámetros de entrada

api_idstringObligatorio
The API identifier (UUID format)
api_version_idstringObligatorio
The API version identifier (UUID format)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import OpenAPI DefinitionPOSTMAN_IMPORT_AN_OPENAPI_DEFINITIONAcción

Tool to import an OpenAPI definition into Postman as a new collection. Use when you need to convert an OpenAPI specification into a Postman collection within a specific workspace.

Parámetros de entrada

typestringObligatorio
The type of import. Use 'string' for JSON string input or 'file' for file upload
inputstringObligatorio
The OpenAPI definition as a JSON string. Must be a valid OpenAPI 3.0+ specification with required fields like 'openapi', 'info', and 'paths'
workspace_idstringObligatorio
The unique identifier of the workspace where the OpenAPI definition will be imported as a collection

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import OpenAPI SpecificationPOSTMAN_IMPORT_OPENAPIAcción

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.

Parámetros de entrada

typestringObligatorio
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'.
inputstringObligatorio
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'.
workspacestringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Account InvoicesPOSTMAN_LIST_ACCOUNT_INVOICESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
Array of invoice objects containing invoice details
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge a ForkPOSTMAN_MERGE_A_FORKAcción

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.

Parámetros de entrada

sourcestringObligatorio
The UID of the forked collection (source) to merge from
strategyany
Optional merge strategy: 'deleteSource' (merge and delete forked collection) or 'updateSourceWithDestination' (merge and update both collections)
destinationstringObligatorio
The UID of the parent collection (destination) to merge into

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge a forked environmentPOSTMAN_MERGE_A_FORK2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Publish a Mock ServerPOSTMAN_PUBLISH_A_MOCK_SERVERAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Pull Source Changes into ForkPOSTMAN_PULL_SOURCE_CHANGES2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replace an Environment's DataPOSTMAN_REPLACE_AN_ENVIRONMENTS_DATAAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Replace Collection Data AsynchronouslyPOSTMAN_REPLACE_COLLECTIONS_DATA_ASYNCHRONOUSLYAcción

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.

Parámetros de entrada

collectionobjectObligatorio
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_idstringObligatorio
The unique identifier (ID or UID) of the collection to replace

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Resolve a Comment ThreadPOSTMAN_RESOLVE_A_COMMENT_THREADAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Review a Pull RequestPOSTMAN_REVIEW_A_PULL_REQUESTAcción

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.

Parámetros de entrada

actionstringObligatorioenum
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
approvedeclineunapprove
pull_request_idstringObligatorio
The unique identifier of the pull request to review

Parámetros de salida

dataany
Task data containing the updated pull request review status
errorany
Error if any occurred during the execution of the action
messageany
Response message indicating success or additional information
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run a MonitorPOSTMAN_RUN_A_MONITORAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Collection with API SchemaPOSTMAN_SYNC_COLLECTION_WITH_SCHEMAAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Collection with SpecificationPOSTMAN_SYNC_COLLECTION_WITH_SPECAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Sync Spec with CollectionPOSTMAN_SYNC_SPEC_WITH_COLLECTIONAcción

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.

Parámetros de entrada

spec_idstringObligatorio
The unique identifier of the API specification to sync. Must be in UUID format.
collection_uidstringObligatorio
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Transfer FoldersPOSTMAN_TRANSFER_FOLDERSAcción

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.

Parámetros de entrada

idsstring[]Obligatorio
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.
modestringObligatorioenum
Transfer mode: 'copy' creates duplicates of folders in target, 'move' relocates folders to target (removes from source).
copymove
targetobjectObligatorio
Target location where folders should be transferred. Specify the model type (collection or folder) and its UID.
locationobjectObligatorio
Position within the target where folders should be placed. Specify 'start' or 'end' for the position.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Transform Collection to OpenAPIPOSTMAN_TRANSFORM_COLLECTION_TO_OPENAPIAcción

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.

Parámetros de entrada

collection_idstringObligatorio
The unique identifier of the collection to transform into OpenAPI format

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a FolderPOSTMAN_UPDATE_A_FOLDERAcción

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.

Parámetros de entrada

nameany
The new name for the folder
folder_idstringObligatorio
The unique identifier of the folder to update
descriptionany
Optional updated description for the folder explaining its purpose
collection_idstringObligatorio
The unique identifier of the collection containing the folder

Parámetros de salida

dataany
Data about the updated folder
metaany
Metadata about the folder update operation
errorany
Error if any occurred during the execution of the action
model_idany
The model ID of the updated folder
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a Folder's CommentPOSTMAN_UPDATE_A_FOLDERS_COMMENTAcción

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.

Parámetros de entrada

bodystringObligatorio
The updated text content of the comment.
comment_idstringObligatorio
The unique identifier of the comment to update.
folder_uidstringObligatorio
The unique identifier (UID) of the folder containing the comment.
collection_uidstringObligatorio
The unique identifier (UID) of the collection containing the folder.

Parámetros de salida

dataany
The updated comment object with all its details
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a Mock ServerPOSTMAN_UPDATE_A_MOCK_SERVERAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a MonitorPOSTMAN_UPDATE_A_MONITORAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an APIPOSTMAN_UPDATE_AN_APIAcción

Tool to update an existing API in Postman. Use when you need to modify the name, summary, or description of an API.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an API's CommentPOSTMAN_UPDATE_AN_APIS_COMMENTAcción

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.

Parámetros de entrada

bodystringObligatorio
The updated text content of the comment.
api_idstringObligatorio
The API's unique identifier. This identifies the API containing the comment to update.
comment_idintegerObligatorio
The comment's unique identifier. This is the ID of the comment to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an EnvironmentPOSTMAN_UPDATE_AN_ENVIRONMENTAcción

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.

Parámetros de entrada

operationsobject[]Obligatorio
Array of JSON Patch operations to apply to the environment. Each operation modifies a specific field using the RFC 6902 format
environment_idstringObligatorio
The unique identifier (ID or UID) of the environment to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a Pull RequestPOSTMAN_UPDATE_A_PULL_REQUESTAcción

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.

Parámetros de entrada

titlestringObligatorio
The updated title of the pull request. This should summarize the changes being proposed.
reviewersstring[]Obligatorio
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_idstringObligatorio
The UID of the source collection (forked collection). Format: {owner}-{collectionId}. This field is required even when updating a pull request.
descriptionstringObligatorio
The updated description for the pull request. Provides context for reviewers about the changes.
destination_idstringObligatorio
The UID of the destination collection (parent collection). Format: {owner}-{collectionId}. This field is required even when updating a pull request.
pull_request_idstringObligatorio
The unique identifier of the pull request to update. This is the pull request ID returned when the pull request was created.

Parámetros de salida

dataany
The updated pull request object containing details about the pull request
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Request in CollectionPOSTMAN_UPDATE_A_REQUESTAcción

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.

Parámetros de entrada

nameany
The updated name of the request
requestany
The updated request object containing method, URL, headers, body, and other request details following the Postman Collection Format
request_idstringObligatorio
The unique identifier of the request to update
collection_idstringObligatorio
The unique identifier of the collection containing the request

Parámetros de salida

dataany
Data about the updated request
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a Request's CommentPOSTMAN_UPDATE_A_REQUESTS_COMMENTAcción

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.

Parámetros de entrada

bodystringObligatorio
The updated text content of the comment.
comment_idintegerObligatorio
The comment's unique identifier. This is the ID of the comment to update.
request_uidstringObligatorio
The request's unique ID (UID). This identifies the specific request containing the comment.
collection_uidstringObligatorio
The collection's unique ID (UID). This identifies the collection containing the request.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a ResponsePOSTMAN_UPDATE_A_RESPONSEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataany
Data about the updated response
metaany
Metadata about the response operation
errorany
Error if any occurred during the execution of the action
model_idany
The ID of the updated response
revisionany
The revision number of the collection after update
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a Response's CommentPOSTMAN_UPDATE_A_RESPONSES_COMMENTAcción

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.

Parámetros de entrada

bodystringObligatorio
The updated text content of the comment.
comment_idstringObligatorio
The unique identifier of the comment to update.
response_uidstringObligatorio
The unique identifier (UID) of the response containing the comment.
collection_uidstringObligatorio
The unique identifier (UID) of the collection containing the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a Server ResponsePOSTMAN_UPDATE_A_SERVER_RESPONSEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Spec FilePOSTMAN_UPDATE_A_SPEC_FILEAcción

Tool to update an API specification file's content. Use when you need to modify the contents of a specific file within a spec.

Parámetros de entrada

contentstringObligatorio
The updated content of the spec file in YAML or JSON format
spec_idstringObligatorio
The unique identifier of the API specification
file_pathstringObligatorio
The path of the file within the spec to update (e.g., 'openapi.yaml', 'components/schemas.yaml')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Spec PropertiesPOSTMAN_UPDATE_A_SPECS_PROPERTIESAcción

Tool to update an API specification's properties such as its name. Use when you need to modify metadata of an existing spec.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a WorkspacePOSTMAN_UPDATE_A_WORKSPACEAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Workspace Global VariablesPOSTMAN_UPDATE_GLOBAL_VARIABLESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Collection PropertiesPOSTMAN_UPDATE_PART_OF_A_COLLECTIONAcción

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.

Parámetros de entrada

collectionobjectObligatorio
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_idstringObligatorio
The unique identifier (ID or UID) of the collection to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorany
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not