Postman
API integration

list_all_postman_analytics

Get Postman analytics data for a given resource and metric, with optional filters for workspace type, duration, period, user type, and entity type. Returns metric-specific analytics data whose shape varies by the resource:metric combination. Required: resource, metrics.

list_all_postman_analytics_metadatas

List Postman analytics metadata — a catalog of analytics resources and their corresponding metrics for use with the GET /analytics endpoint. Returns the analytics metadata catalog with available resources, metrics, and optionally detailed parameter and response schema information. Filter by resources (user, workspace, team, ai) or specific metric values.

list_all_postman_apis

List all APIs in a Postman workspace, optionally filtered by creator or description text. Returns each API's id, name, summary, and description. Required: workspace_id.

create_a_postman_api

Create an API in a Postman workspace. Returns the created API object including its id, name, summary, and description. Required: workspace_id, name.

get_single_postman_api_by_id

Get a single Postman API by id. Returns: id, description, schemas. Required: id.

update_a_postman_api_by_id

Update a Postman API by id. Returns the updated API object including its id, name, and description. Required: id, name.

delete_a_postman_api_by_id

Delete a Postman API by id. Returns an empty 204 response on success. Required: id.

postman_apis_list_comments

List all comments left by users on a Postman API. Returns: id, threadId, status, createdBy, createdAt, updatedAt, body. Required: api_id.

postman_apis_attach_comment

Create a comment on a Postman API. To reply to an existing comment, include threadId in the request body. Returns: data. Accepts a max of 10,000 characters. Required: api_id, body.

postman_apis_list_tags

List all tags associated with a Postman API. Returns: tags. Required: api_id.

postman_apis_bulk_update

Replace all tags associated with a Postman API. This endpoint replaces all existing tags with those passed in the request body. Returns: tags. Required: api_id, tags.

create_a_postman_api_collection

Add a collection to a Postman API by copying, creating from content, or generating from a schema. Returns the collection object with collection-format-specific fields. Options properties are case-sensitive with GENERATE_FROM_SCHEMA. Required: api_id.

list_all_postman_api_collections

Get a collection attached to a Postman API by collection ID. Returns the collection object with collection-format-specific fields. Cannot retrieve Git-linked API collections; versionId is required for API viewers. Required: api_id, collection_id.

postman_api_collections_list_comments

List all comments left by users on a Postman API's collection. Returns each comment with its id, body, and threadId. Required: api_id, collection_id.

postman_api_collections_attach_comment

Create a comment on a Postman API's collection. Returns the created comment with its id, body, and threadId. Accepts a max of 10,000 characters; include threadId to create a reply. Required: api_id, collection_id, body.

update_a_postman_collection_comment_by_id

Update a comment on an API's collection in Postman. Returns the updated comment object including id, body, and threadId. Accepts a maximum of 10,000 characters. Required: id, api_id, collection_id, body.

delete_a_postman_collection_comment_by_id

Delete a comment from a Postman API's collection. Returns an empty 204 response on success. Deleting the first comment of a thread deletes all comments in that thread. Required: id, api_id, collection_id.

postman_collection_sync_with_schema_tasks_bulk_update

Sync a Postman collection attached to an API with the API schema. This is an asynchronous endpoint that returns a 202 Accepted response with a task id; poll the task status via the /apis/{apiId}/tasks/{taskId} endpoint (the polling link is also returned in the Location header). Returns: id. Only supports the OpenAPI 3 schema type. Required: api_id, collection_id.

update_a_postman_api_comment_by_id

Update a comment on a Postman API. Returns the updated comment object including id, body, and threadId. The comment body accepts a maximum of 10,000 characters. Required: id, api_id, body.

delete_a_postman_api_comment_by_id

Delete a comment from a Postman API. Returns an empty 204 response on success. Deleting the first comment of a thread deletes all comments in the thread. Required: id, api_id.

create_a_postman_api_schema

Create a schema for an API in Postman. Returns the created schema object including its id, files, and createdAt. Required: api_id, type, files.

list_all_postman_api_schemas

Get a Postman API schema's metadata and files by api_id and schema_id. Returns: id, files, createdAt, updatedAt. Only the first file is included with a link to retrieve additional files. The versionId parameter is required for API viewers. Required: api_id, schema_id.

list_all_postman_schema_files

List schema files in a Postman API schema. Returns: meta, files. Required: api_id, schema_id.

get_single_postman_schema_file_by_id

Get the contents of a Postman API schema file at the specified file path. Returns the schema file object including its content and contentType. The version_id query parameter is required for API viewers to retrieve schema file contents published in an API version. Required: api_id, schema_id, file_path.

postman_schema_files_bulk_update

Create or update a schema file in a Postman API schema. If the path exists the file is updated; otherwise a new file is created. Returns: createdBy, createdAt, root, name, path, updatedBy, id, updatedAt, content. Required: api_id, schema_id, file_path.

postman_schema_files_bulk_delete

Delete a schema file from a Postman API schema. Returns an empty 204 response on success. Required: api_id, schema_id, file_path.

list_all_postman_api_tasks

Get the status of an asynchronous Postman API task. Returns the task status object including its id. Required: api_id, task_id.

list_all_postman_api_versions

List all published versions of a Postman API. Returns each version's id and status. Required: api_id.

create_a_postman_api_version

Create a new Postman API version asynchronously. Returns a 202 Accepted response; the polling link to the task status API is provided in the Location header. This is equivalent to publishing a version snapshot of the API's collections and schema. Required: api_id.

update_a_postman_api_version_by_id

Update a Postman API version by id. Returns: id, name, createdAt, updatedAt, releaseNotes, status. Returns 404 Not Found when the version is pending publication. Required: id, api_id, name.

delete_a_postman_api_version_by_id

Delete a Postman API version by id. Returns an empty 204 response on success. Returns 404 Not Found when the version is pending publication. Required: id, api_id.

get_single_postman_api_version_by_id

Get a specific API version in Postman. Returns the version object including its id and status. Returns 302 for API editors and 404 for API viewers when the version status is pending. Required: id, api_id.

list_all_postman_api_catalog_discovery_services

List discovered services in the Postman API Catalog. Returns: id, name, version, status, tags. Max 100 results per page.

create_a_postman_api_catalog_discovery_service

Add discovered services to the Postman API Catalog. Accepts up to 20 services in a single call. Returns: id, description, version, tags, status, name. Required: discoveredServices.

get_single_postman_api_catalog_discovery_service_by_id

Get detailed information about a discovered service in Postman by id, including a base64-encoded OpenAPI specification and an array of endpoints. Returns: id, name, description, version, tags, status, endpoints. Required: id.

list_all_postman_api_catalog_services

List API Catalog services in a Postman system environment. Returns each service's id, name, health, traffic, compliance, ownership, dependencies, and analytics. Required: system_environment_id.

get_single_postman_api_catalog_service_by_id

Get a single API Catalog service by id in Postman, including its health, traffic, compliance, ownership, and dependencies. Returns: meta, data. Required: id, system_environment_id.

list_all_postman_service_endpoints

List observed API endpoints for a Postman API Catalog service with performance metrics. Returns: method, path, host, requestCount, performance, errors. Max 100 results per page. Required: service_id, system_environment_id.

list_all_postman_service_monitor_runs

List scheduled monitor runs for a Postman API Catalog service, including summary statistics. Returns: id, status, timestamp, collection, environment, summary, performance, duration, failedAssertions. Max 100 per page. Required: service_id, system_environment_id.

list_all_postman_service_spec_lints

List API specification lint runs for a Postman service in the API Catalog, including summary statistics and per-severity issue counts. Returns: timestamp, status, issues, id. Required: service_id.

list_all_postman_service_ci_runs

List CI collection runs for a Postman API Catalog service with summary statistics, pipeline details, and Git metadata. Returns: id, status, timestamp, collection, environment, source, pipeline, execution, summary, performance, branch, workflowName, actor, repoName, repoOwner, collectionId, environmentId, duration. Max 100 per page. Required: service_id, system_environment_id.

list_all_postman_api_catalog_system_environments

List all of the authenticated team's system environments in Postman. Returns: id, name, label, color, description, isProduction, associationCount, createdAt, updatedAt. Filter to production environments only using the isProduction parameter.

create_a_postman_api_catalog_system_environment

Create a system environment for the authenticated team in Postman. Returns the created system environment including its id, name, and isProduction flag. Required: name, color.

get_single_postman_api_catalog_system_environment_by_id

Get a single system environment by id in Postman. Returns: data. Required: id.

update_a_postman_api_catalog_system_environment_by_id

Update a system environment in Postman by id. You can update one or more fields in a single call. Returns: data. The name must be unique within the team. Required: id.

list_all_postman_system_environment_associations

List workspace-environment associations for a Postman system environment, optionally filtered by workspace. Returns the association records for the specified system environment. Required: system_environment_id.

create_a_postman_system_environment_association

Add workspace-environment associations to a Postman system environment. Returns the result of the association add operation. Required: system_environment_id, workspaceEnvironmentIds.

postman_system_environment_associations_bulk_delete

Remove workspace-environment associations from a Postman system environment. Returns the result of the association removal operation. Required: system_environment_id, workspaceEnvironmentIds.

create_a_postman_security_api_validation

Validate an API definition against Postman's predefined security rulesets. Returns: warnings. Max definition size 10 MB; OWASP security rules must be enabled to receive violations.

list_all_postman_audit_logs

List Postman team audit log events, optionally filtered by user, action, or date range. Returns a paginated list of audit log events. All parameters are optional; results default to descending order.

list_all_postman_audit_actions

List all available audit log event actions in Postman. Returns: actions — a complete list of audit log event action names usable as filter values for audit log queries.

list_all_postman_accounts

Get Postman billing account details for the given team. Returns: id, state, slots.

list_all_postman_account_invoices

List all invoices for a Postman billing account, filtered by invoice status. Returns: id, status, issuedAt, totalAmount, links. Required: account_id, status.

list_all_postman_collection_access_keys

List Postman collection access keys for the authenticated user and their team. Returns: id, token, status, teamId, userId, collectionId, expiresAfter, lastUsedAt, createdAt, updatedAt, deletedAt. Collection access keys are valid for 60 days; if unused, lastUsedAt returns an empty string.

delete_a_postman_collection_access_key_by_id

Delete a Postman collection access key by id. Returns an empty 204 response on success. Required: id.

list_all_postman_collection_folders

List comments left by users in a Postman collection folder. Returns: id, threadId, status, createdBy, createdAt, updatedAt, body. Required: collection_id, folder_id.

postman_collection_folders_attach_comment

Create a comment on a Postman collection folder, or reply to an existing comment thread by including threadId. Returns: data. Max 10,000 characters. Required: collection_id, folder_id, body.

create_a_postman_collection_folder

Create a folder in a Postman collection. Returns: data, meta, model_id, revision. Passing a name is recommended; if omitted, the folder is created with a blank name. Required: collection_id.

update_a_postman_collection_folder_by_id

Update a Postman collection folder. Returns: data, meta, model_id, revision. Acts like a PATCH — only values passed in the request body are updated. Required: id, collection_id.

delete_a_postman_collection_folder_by_id

Delete a folder in a Postman collection. Returns the deleted folder object including id, name, description, and item. Required: id, collection_id.

get_single_postman_collection_folder_by_id

Get a folder in a Postman collection by id. Returns the folder object including id, name, description, and item. Required: id, collection_id.

update_a_postman_folder_comment_by_id

Update a folder's comment. Returns: data. Required: id, collection_id, folder_id, body.

delete_a_postman_folder_comment_by_id

Delete a comment from a folder in Postman. Returns an empty 204 response on success. Deleting the first comment of a thread deletes all comments in the thread. Required: id, collection_id, folder_id.

create_a_postman_collection_request

Create a new request in a Postman collection. Returns the created request object including its id, with additional schema-specific fields defined by the Postman Collection Format. It is recommended to pass the name property in the request body; omitting it creates a request with a blank name. Required: collection_id.

list_all_postman_collection_requests

Get a single request from a Postman collection by its ID. Returns the request object including its id, with additional schema-specific fields defined by the Postman Collection Format. Required: request_id, collection_id.

update_a_postman_collection_request_by_id

Update a request in a Postman collection. Returns the updated request object including its id, with additional schema-specific fields defined by the Postman Collection Format. This endpoint does not support changing the folder of a request. Required: id, collection_id.

delete_a_postman_collection_request_by_id

Delete a request from a Postman collection. Returns the deleted request object including its id, with additional schema-specific fields. Required: id, collection_id.

postman_collection_requests_list_comments

List all comments left by users on a request in a Postman collection. Returns comment objects including their id, with additional schema-specific comment fields. Required: collection_id, request_id.

postman_collection_requests_attach_comment

Create a comment on a Postman collection request. To reply to an existing comment, include the threadId property in the request body. Returns: data. Accepts a max of 10,000 characters. Required: collection_id, request_id, body.

create_a_postman_collection_response

Create a new response in a Postman collection. The request body follows the Postman Collection Format Response schema; passing a name is recommended. Returns the response object with Postman Collection Format-specific fields. Required: collection_id, request.

list_all_postman_collection_responses

Get a single Postman collection response by id. Returns the response object with Postman Collection Format-specific fields. Required: response_id, collection_id.

update_a_postman_collection_response_by_id

Update a Postman collection response. Acts like a PATCH — only passed values are updated, not the entire resource. Use a collection ID, not a UID. Returns the response object with Postman Collection Format-specific fields. Required: id, collection_id.

delete_a_postman_collection_response_by_id

Delete a Postman collection response by id. Returns the delete operation response. Required: id, collection_id.

postman_collection_responses_list_comments

List all comments left by users on a Postman collection response. Returns the comment objects with Postman API-specific fields. Required: collection_id, response_id.

postman_collection_responses_attach_comment

Create a comment on a Postman collection response. Include threadId in the request body to reply to an existing comment. Returns the created comment including its id, body, and threadId. Accepts a max of 10,000 characters. Required: collection_id, response_id, body.

update_a_postman_request_comment_by_id

Update a comment on a Postman collection request. Returns: data. Accepts a max of 10,000 characters. Required: id, collection_id, request_id, body.

delete_a_postman_request_comment_by_id

Delete a comment from a Postman collection request. Returns an empty 204 response on success. Deleting the first comment of a thread deletes all comments in the thread. Required: id, collection_id, request_id.

update_a_postman_response_comment_by_id

Update a comment on a collection response in Postman. Returns the updated comment object including id, body, author, and createdAt. Accepts a maximum of 10,000 characters in the comment body. Required: id, collection_id, response_id, body.

delete_a_postman_response_comment_by_id

Delete a comment from a collection response in Postman. Returns an empty 204 response on success. Deleting the first comment of a thread deletes all comments in the thread. Required: id, collection_id, response_id.

postman_collection_merges_bulk_update

Merge or pull changes between a forked collection and its parent collection asynchronously in Postman. Returns: task. The operation is asynchronous — use the returned id to poll the merge status via the collection-merges-tasks endpoint. Required: strategy, source, destination.

get_single_postman_collection_merges_task_by_id

Get the status of a Postman collection merge or pull changes task by id. Returns: id, status, details. Task status is only available for 24 hours after the merge succeeds or fails, after which the endpoint returns 404. Required: id.

list_all_postman_collections

List all Postman collections including your subscribed collections. Returns: collections, meta. Name filtering cannot be combined with pagination.

create_a_postman_collection

Create a Postman collection in a workspace using the Postman Collection v2.1.0 schema format. Returns the collection object with content-type-specific fields. Required: workspace.

get_single_postman_collection_by_id

Get a single Postman collection by id. Returns the collection object with content-type-specific fields. Required: id.

update_a_postman_collection_by_id

Replace a Postman collection's contents by id using the Postman Collection v2.1.0 schema format. Returns the collection object with content-type-specific fields. Max collection size 100 MB; omitting item IDs in the body removes and recreates items with new IDs. Required: id.

delete_a_postman_collection_by_id

Delete a Postman collection by id. Returns the deleted collection's id and uid. Required: id.

postman_collections_list_comments

List all comments left by users on a Postman collection. Returns each comment's id, body, threadId, and createdAt. Required: collection_id.

postman_collections_attach_comment

Create a comment on a Postman collection. Include threadId in the request body to create a reply on an existing comment. Returns the created comment's id, body, threadId, and createdAt. Max 10,000 characters. Required: collection_id, body.

postman_collections_list_tags

Get a collection's tags. Returns: tags. Required: collection_id.

postman_collections_bulk_update

Update a Postman collection's tags by replacing all existing tags with those passed in the request body. Returns the collection's updated tags. Required: collection_id, tags.

postman_collections_partial_update

Partially update a Postman collection by id, modifying specific collection information such as its name, events, or variables. Returns: id, name, description, uid. Required: id.

list_all_postman_collections_collection_forks

List all collections forked by the authenticated user in Postman. Returns: createdAt, id. Use the optional direction parameter to sort results by creation date in ascending or descending order.

create_a_postman_collections_fork

Create a fork from an existing Postman collection into a workspace. Returns the created fork response object. Required: fork_id, workspace, label.

create_a_postman_collections_merge

Merge a fork. Returns: collection. Required: destination, source.

create_a_postman_collection_duplicate

Duplicate a Postman collection into another workspace asynchronously. Returns: task. Required: collection_id, workspace.

list_all_postman_collection_forks

List forks of a specific Postman collection. Returns: createdAt, id. Required: collection_id.

postman_collection_public_documentations_bulk_update

Publish a Postman collection's documentation, making it publicly available to anyone with the link. Returns: published, customization, id. Only supported for collections with HTTP requests; cannot be used on collections added to an API. Required: collection_id, customColor, customization.

postman_collection_public_documentations_bulk_delete

Unpublish a Postman collection's public documentation. Returns an empty 204 response on success. Required: collection_id.

postman_collection_pulls_bulk_update

Pull changes from a parent (source) collection into a forked Postman collection. Returns: collection. Required: collection_id.

list_all_postman_collection_pull_requests

List pull requests for a Postman collection, including source and destination IDs and status. Returns: createdAt, createdBy, description, destinationId, href, id, sourceId, status, comment, title, updatedBy, updatedAt. Required: collection_id.

create_a_postman_collection_pull_request

Create a pull request for a forked Postman collection into its parent collection. Returns: createdAt, createdBy, description, destinationId, id, sourceId, status, title, updatedAt. Required: collection_id, title, reviewers, destinationId.

list_all_postman_collection_roles

List all roles in a Postman collection. Returns the IDs and access levels of all users, teams, and groups with access to view or edit the collection. Required: collection_id.

postman_collection_roles_bulk_update

Update the roles of users, groups, or teams in a Postman collection. Returns an empty 204 response on success. Only Editor-role users can call this endpoint; Partner and Guest roles are not supported. Required: collection_id, roles.

list_all_postman_collection_source_status

Get the source collection status for a forked Postman collection, checking whether the forked collection differs from its parent (source) collection. Returns: collection. This endpoint may take a few minutes to return an updated isSourceAhead status. Required: collection_id.

list_all_postman_collection_transformations

Transform a Postman collection into a stringified OpenAPI definition. Returns a stringified OpenAPI definition whose contents depend on the collection being transformed. Required: collection_id.

create_a_postman_collection_folders_transfer

Transfer folders. Returns: ids. Required: ids, mode, target, location.

create_a_postman_collection_requests_transfer

Copy or move Postman collection requests into a collection or folder. Accepts a JSON request body defining the transfer operation. Returns a JSON response with the transfer result. Required: ids, mode, target, location.

create_a_postman_collection_responses_transfer

Transfer (copy or move) Postman collection responses into a request. Returns the transfer operation result. Requires a JSON request body. Required: ids, mode, target, location.

get_single_postman_collection_duplicate_task_by_id

Get the status of a collection duplication task in Postman by task id. Returns: task. Required: id.

get_single_postman_collection_updates_task_by_id

Get the status of an asynchronous collection update task in Postman. Returns: id, status. Required: id.

create_a_postman_comments_resolution

Resolve a comment thread and any associated replies in Postman. Returns an empty 204 response on success. Required: comments_resolution_id.

list_all_postman_components

List all components in the team's Postman component library. Returns: id, name, type, status, createdAt, updatedAt, createdBy, updatedBy, hasVersions, latestVersion. Filter by type, status, or whether the component has published versions; use include and expand to request additional fields such as hasVersions and latestVersion.

create_a_postman_component

Create a new Postman component in an active state with an initial draft. Returns: id, type, name. The component is created active; use the component versions endpoint to publish a version after creation. Required: name, type, content.

get_single_postman_component_by_id

Get a single Postman component by id. Returns: data. Use include and expand to request additional fields such as hasVersions and the latest published version. Required: id.

update_a_postman_component_by_id

Update a Postman component's name or lifecycle status by id. Returns: id, name, status, type, hasVersions, latestVersion. Name and status can't be updated in the same call — make separate calls for each. Status accepts active or archive. Required: id.

list_all_postman_component_drafts

Get the current working draft of a Postman component. Drafts represent the latest unpublished edits, which may differ from the most recently published version. Returns: content, format. Required: component_id.

postman_component_drafts_bulk_update

Update a Postman component's draft with new unpublished edits. You can't update archived components. Returns: id. Required: component_id.

list_all_postman_component_versions

List all published versions of a Postman component. Returns: id, label, url, format, publishedAt, content. Required: component_id.

create_a_postman_component_version

Publish a new version of a Postman component from its current draft. Returns: id, content. Archived components must be reactivated before publishing a new version. Required: component_id, label.

get_single_postman_component_version_by_id

Get a specific published version of a Postman component by id. Returns: id, content. Required: id, component_id.

list_all_postman_environments

List all Postman environments, optionally filtered by workspace. Returns each environment with id, name, uid, and values.

create_a_postman_environment

Create a new Postman environment in a workspace. Returns: environment. If workspace is omitted, the environment is created in your oldest personal Internal workspace. Required: workspace.

get_single_postman_environment_by_id

Get a single Postman environment by id. Returns: environment. Required: id.

update_a_postman_environment_by_id

Replace all contents of a Postman environment by id. Returns: environment. Required: id.

delete_a_postman_environment_by_id

Delete a Postman environment by id. Returns a 200 response on successful deletion. Required: id.

postman_environments_partial_update

Partially update a Postman environment's properties such as its name and variables using add or replace patch operations. Returns the updated environment including id, name, and values. Only one operation type per call; only shared variable values can be modified; request body max 30MB. Required: id.

list_all_postman_environment_forks

List all forks of a Postman environment. Returns: forkId, forkName, createdAt, createdBy, updatedAt, id, name. Required: environment_id.

create_a_postman_environment_fork

Create a fork of an existing Postman environment into a specified workspace. Returns the forked environment object including its id, name, and createdAt. Required: environment_id, workspace_id, forkName.

create_a_postman_environment_merge

Merge a forked Postman environment back into its parent environment. Returns a merge response object. The response field set is not enumerated in the discovered API source. Required: environment_id, source.

create_a_postman_environment_pull

Pull changes from a parent (source) environment into a forked environment in Postman. Returns a pull environment response confirming the changes were pulled into the forked environment. Required: environment_uid, source.

list_all_postman_groups

List all Postman user groups for a team. Returns: id, teamId, summary, createdBy, createdAt, updatedAt, members, roles, name.

get_single_postman_group_by_id

Get information about a specific Postman user group by id. Returns: id, teamId, name, summary, createdBy, createdAt, updatedAt, members, roles, managers. Required: id.

create_a_postman_import_openapi

Import an OpenAPI definition into Postman as a new Postman Collection. Returns the import result. The Postman web app does not support the file input method type. Required: workspace.

list_all_postman_mocks

List all active Postman mock servers you created, optionally filtered by team or workspace. Returns each mock server's id, name, and collection. If both teamId and workspace are passed, only workspace is used.

create_a_postman_mock

Create a Postman mock server in a collection. Returns the created mock server's id, name, and collection. Cannot create mocks for collections added to an API definition. Required: workspace.

get_single_postman_mock_by_id

Get information about a specific Postman mock server by id. Returns: mock. Required: id.

update_a_postman_mock_by_id

Update a Postman mock server's properties, such as its name or collection. Returns the updated mock server's id, name, and collection. Required: id.

delete_a_postman_mock_by_id

Delete a Postman mock server by id. Returns: mock. Required: id.

postman_mocks_publish

Publish a Postman mock server, setting its Access Control configuration to public. Returns the mock server object including id, uid, name, and collection. Required: mock_id.

postman_mocks_delete_unpublish

Unpublish a Postman mock server, setting its Access Control configuration to private. Returns the mock server object including id, uid, name, and collection. Required: mock_id.

list_all_postman_mock_call_logs

List call logs for a Postman mock server, containing exchanged request and response data made to the mock server. Returns: call-logs, meta. Max 100 call logs or 6.5MB per call, whichever limit is met first; sort and direction parameters must be used together. Required: mock_id.

list_all_postman_mock_server_responses

List all server responses for a Postman mock server. Returns: id, name, createdAt, updatedAt. Required: mock_id.

create_a_postman_mock_server_response

Create a server response on a Postman mock server to simulate 5xx server-level responses such as 500 or 503. Returns: createdAt, updatedAt, id, name, statusCode, headers, language, body, createdBy, updatedBy, mock. Only one server response can be set as active per mock server. Required: mock_id.

update_a_postman_mock_server_response_by_id

Update a server response on a Postman mock server. Returns: createdAt, updatedAt, id, name, statusCode, headers, language, body, createdBy, updatedBy, mock. Required: id, mock_id.

delete_a_postman_mock_server_response_by_id

Delete a server response from a Postman mock server. Returns an empty 204 response on success. Required: id, mock_id.

get_single_postman_mock_server_response_by_id

Get a Postman mock server response by id. Returns the server response object including its id. Required: id, mock_id.

list_all_postman_monitors

List Postman monitors with optional filters by workspace, active status, owner, collection, or environment. Returns: monitors, meta. Max 25 per page.

create_a_postman_monitor

Create a Postman monitor in a workspace. Returns: monitor. You cannot create monitors for collections added to an API definition. Required: workspace.

get_single_postman_monitor_by_id

Get a single Postman monitor by id. Returns: monitor. Required: id.

update_a_postman_monitor_by_id

Update a Postman monitor's configurations by id. Returns: monitor. Required: id.

delete_a_postman_monitor_by_id

Delete a Postman monitor by id. Returns: monitor. Required: id.

create_a_postman_monitor_run

Run a Postman monitor by id and retrieve its run results. Returns: run. When async=true is passed, stats, executions, and failures are omitted from the response; retrieve them via the GET monitor endpoint. If the call exceeds 300 seconds, an HTTP 202 Accepted response is returned — check the run's status via the GET monitor endpoint's lastRun property. Required: monitor_id.

list_all_postman_runner_instances

List all instances of a Postman runner that are polling for upcoming monitor runs. Each instance is a runner execution sharing the same runner ID and key. Returns: id, hostname. Maximum 25 rows per page. Required: runner_id.

list_all_postman_runner_metrics

Get Postman server-side metrics for a runner instance. Returns: metrics including monitor run queues and last polling date. Required: runner_id.

create_a_postman_oauth_2_token

Generate an OAuth 2.0 access token in Postman for backend service or bot authentication using the client_credentials grant type. Returns the generated access token. Client ID and client secret must be passed as Basic Auth credentials. Required: grant_type, installationAuthId, jwt.

create_a_postman_token_revoke

Revoke an active OAuth 2.0 access token in Postman, preventing further API use. Revocation is immediate and irreversible. This request does not use any authorization. Returns a confirmation response. Required: token.

create_a_postman_generations_tool

Generate code for an AI agent tool from a Postman public collection and request. This endpoint is deprecated and only supports public Postman Collections and requests. The request body and response schemas are referenced but not documented in the available source. Required: requestId, collectionId, config.

list_all_postman_network_privates

List workspaces added to your team's Private API Network in Postman. Returns each workspace with id, name, summary, description, type, addedBy, createdBy, createdAt, and updatedAt. The sort and direction parameters must be used together.

create_a_postman_network_private

Add a workspace to your team's Private API Network in Postman. Returns the created network element including its id, name, summary, description, addedBy, and createdAt. Required: workspace.

update_a_postman_private_workspace_by_id

Update a workspace element or folder in Postman's Private API Network. This endpoint is deprecated. Returns the updated workspace including its id, name, description, createdAt, and updatedAt. Required: id.

delete_a_postman_private_workspace_by_id

Remove a workspace from your team's Private API Network in Postman. Returns the removed workspace element's id. Removing a workspace does not delete it — it only removes it from the Private API Network folder. Required: id.

list_all_postman_request_alls

List all requests to add workspaces to your team's Private API Network in Postman. Returns: requests, meta. The sort and direction parameters must be used together.

update_a_postman_network_entity_request_by_id

Approve or deny a Postman Private API Network workspace add request by responding to it. Returns the updated request with id, status, requestedBy, type, name, createdAt, and updatedAt. Required: id, status.

get_single_postman_pull_request_by_id

Get a Postman pull request by id. Returns the pull request object including its id and attributes containing source and destination details, reviewer information, merge status, and accessibility. Required: id.

update_a_postman_pull_request_by_id

Update an open Postman pull request by id. Returns the updated pull request object including its id and attributes. Only open pull requests can be updated; a 409 Conflict is returned otherwise. Required: id, title, reviewers.

create_a_postman_pull_request_task

Review a Postman pull request by updating its review status. Returns the pull request review response object. Required: pull_request_id, action.

list_all_postman_sdks

List all Postman SDKs in a workspace, optionally filtered by build status, language, source ID, or specific SDK IDs. Returns: id. Max 25 results per page; passing sdkIds ignores other filters. Required: workspace_id.

create_a_postman_sdk

Generate a Postman SDK from a collection or specification in one language. Creates an asynchronous generation job — track its buildStatus via the get SDK method until it reaches succeeded. Returns: id. The request body is language-dependent — provide only properties relevant to the chosen language. Required: source, language.

get_single_postman_sdk_by_id

Get a single Postman SDK by id, including its current build job status. Returns: id, language, source, workspaceId, version, buildStatus, error, pullRequest, createdAt, updatedAt, sourceId. Required: id.

delete_a_postman_sdk_by_id

Delete a Postman SDK record and its stored archive by id. Returns an empty 204 response on success. Cannot cancel a generation job that is still in progress. Required: id.

list_all_postman_sdk_downloads

Get a short-lived signed download URL for a generated Postman SDK archive (zip). Returns: id, language, url, expiresAt. The URL is created on demand and expires within a few minutes. Required: sdk_id.

list_all_postman_sdk_git_connections

List all SDK Git connections in a Postman workspace, each linking a collection or specification to a Git repository for one SDK language. Returns: sdkGitConnectionId, source, language, status, repositoryUrl, targetBranch, autoUpdatePullRequestsEnabled, sdk, pullRequests, createdAt, updatedAt, id, pullRequest. Max 25 per page. Required: workspace_id.

create_a_postman_sdk_git_connection

Connect a Postman collection or specification to a Git repository for one SDK language in Postman. Creates a new connection in the active state. Returns: sdkGitConnectionId, source, language, status, repositoryUrl, targetBranch, autoUpdatePullRequestsEnabled, sdk, pullRequests, createdAt, updatedAt, id, pullRequest. Returns 409 Conflict if a connection already exists for the same source and…. Required: source, language, repositoryUrl.

get_single_postman_sdk_git_connection_by_id

Get a single SDK Git connection by id in Postman. The response includes the SDK currently sent to the targetBranch and the most recent SDK-update pull request. Returns: sdkGitConnectionId, source, language, status, repositoryUrl, targetBranch, autoUpdatePullRequestsEnabled, sdk, pullRequests, createdAt, updatedAt, id, pullRequest. Required: id.

update_a_postman_sdk_git_connection_by_id

Update an SDK Git connection's lifecycle status in Postman. Set status to active to reconnect the repository and resume auto-update pull requests, or disconnected to stop them. Returns: sdkGitConnectionId, source, language, status, repositoryUrl, targetBranch, autoUpdatePullRequestsEnabled, sdk, pullRequests, createdAt, updatedAt, id, pullRequest. The inaccessible status is…. Required: id, status.

list_all_postman_sdk_git_connection_pull_requests

List all SDK update pull requests for a Postman SDK Git connection, ordered newest first by updatedAt. Returns: number, url, status, sdk, createdAt, updatedAt. Maximum 25 results per page; direct push requests to the base branch are excluded when the connection is configured to push some changes directly. Required: sdk_git_connection_id.

create_a_postman_search

Search Postman for resources such as workspaces, collections, requests, and other resource types, with filters for ownership, visibility, tags, and other criteria. Returns a paginated list of matching resources. Without an API key, only publicly-available resources are returned. Required: elementType.

create_a_postman_detected_secrets_query

Search for secrets detected by Postman's Secret Scanner, grouped by workspace or resource. Returns: resolution, occurrences. Pass an empty request body to return all results. The since and until query parameters are mutually constrained — since cannot be later than until.

update_a_postman_detected_secret_by_id

Update the resolution status of a detected secret in Postman's Secret Scanner. Returns: resolution, history. Required: id, resolution, workspaceId.

list_all_postman_detected_secret_locations

List locations where a detected secret was found in Postman's Secret Scanner. Returns: location, occurrences, url. Required: secret_id, workspace_id.

list_all_postman_secret_types

List the secret types supported by Postman's Secret Scanner. Returns: id, type. The id can be used to query data with the POST /detected-secrets/{secretId} endpoint.

create_a_postman_service_account_token

Generate a short-lived service account access token in Postman by exchanging a service account API key. Returns a JWT access token encoding the service account's identity and permissions, valid for 15 minutes. The API key must belong to a service account; regular user API keys are not supported.

list_all_postman_api_spec_migrations

Get the status of an API Builder definition's migration to Spec Hub in Postman. Returns: status, details. Required: api_id.

create_a_postman_api_spec_migration

Migrate an API Builder definition to a Spec Hub specification in Postman, either to an existing or new workspace. Returns: message, success. Returns 200 OK if the API ID isn't an API Builder definition; Git-linked definitions require a new workspace. Required: api_id.

list_all_postman_collection_generations

Get the API specification generated for a Postman collection. Returns: specs, meta. Required: collection_uid, element_type.

create_a_postman_collection_generation

Generate an OpenAPI 2.0, 3.0, or 3.1 specification from a Postman collection. Returns a task response containing a polling link to check the async generation status. Required: collection_uid, element_type, name.

postman_collection_synchronizations_bulk_update

Sync collection with spec. Returns: taskId, url. Required: collection_uid, spec_id.

get_single_postman_task_by_id

Get the status of an asynchronous API specification creation task in Postman. Returns: id. Required: id, element_type, element_id.

list_all_postman_specs

List all API specifications in a Postman workspace. Returns: meta, specs. Required: workspace_id.

create_a_postman_spec

Create an API specification in Postman's Spec Hub. Returns: name, type, id, createdAt, updatedAt, createdBy, updatedBy. Supports OpenAPI, AsyncAPI, protobuf, GraphQL, and Smithy. Files cannot exceed 12 MB. Required: workspace_id, name, type, files.

get_single_postman_spec_by_id

Get a spec. Returns: id, fileFormat, name, type, createdBy, updatedBy, createdAt, updatedAt. Required: id.

update_a_postman_spec_by_id

Update a Postman API specification's properties, such as its name. Returns: id, type, createdBy, updatedBy, createdAt, updatedAt, name. Required: id, name.

delete_a_postman_spec_by_id

Delete a Postman API specification by id. Returns an empty 204 response on success. Required: id.

postman_collection_sync_options_bulk_update

Update sync options for a Postman specification's generated collection. Returns the updated sync options object reflecting the configured sync settings. Required: spec_id, collection_id, syncOptions.

list_all_postman_spec_definitions

Get a Postman API specification's complete definition contents. Returns the full OpenAPI or AsyncAPI specification definition for the given spec. Required: spec_id.

list_all_postman_spec_files

List all files in a Postman API specification. Returns: files, meta. Required: spec_id.

create_a_postman_spec_file

Create a file for an OpenAPI or protobuf 2 or 3 specification in Postman. Returns: createdAt, createdBy, id, path, updatedAt, updatedBy, type, content. New files are assigned the DEFAULT type; files cannot exceed 10 MB. Required: spec_id, path, content.

get_single_postman_spec_file_by_id

Get the contents of an API specification file in Postman. Returns the file object including its content, path, and type. Required: spec_id, file_path.

postman_spec_files_bulk_update

Update a file in an OpenAPI or protobuf 2 or 3 specification in Postman. Returns: createdAt, createdBy, id, path, updatedAt, updatedBy, type, content. Pass exactly one body property per call — either content or type, not both. Files cannot exceed 10 MB. Required: spec_id, file_path.

postman_spec_files_bulk_delete

Delete a file in a Postman API specification. Returns an empty 204 response on success. Required: spec_id, file_path.

list_all_postman_spec_generations

List all collections generated from an API specification in Postman. Returns: collections, meta. Required: spec_id, element_type.

create_a_postman_spec_generation

Generate a Postman collection from an OpenAPI 2.0, 3.0, 3.1, or Smithy API specification. Returns: url. The response contains a polling link to the task status. Required: spec_id, element_type, name, options.

postman_spec_synchronizations_bulk_update

Synchronize an API specification with its linked collection in Postman. This asynchronous endpoint returns a 202 Accepted response with a task id. Returns: url. Only supports OpenAPI 2.0, 3.0, and 3.1 specs; the collection must be generated from the given specification ID. Required: spec_id, collection_uid.

list_all_postman_version_tag_files

Get a specification's version tag files from Postman, returning a snapshot of the specification at a point in time for tracking changes over time. Returns: id, name, updatedBy, createdAt, updatedAt, createdBy, type, path, fileType, content, parentId, attributes. Required: spec_id, tag_id.

list_all_postman_spec_version_tags

List version tags for a Postman specification. Returns: id, name. Required: spec_id.

create_a_postman_spec_version_tag

Create a version tag for a Postman specification. Version tags are snapshots that let you track changes over time. Returns: data. A 409 Conflict occurs if the changelog group already has a version tag. Required: spec_id, name.

list_all_postman_tag_entities

List Postman elements (workspaces, APIs, and collections) tagged with a given tag in Postman. Returns: data, meta. Required: slug.

list_all_postman_workspaces

List all Postman workspaces you have access to, including personal and shared workspaces. Returns: id, name, type, visibility, createdBy, about, createdAt, updatedAt, scim. Supports filtering by type, createdBy, include, elementType, and elementId.

postman_workspaces_bulk_update

Replace all tags associated with a Postman workspace. This endpoint replaces all existing tags with those passed in the request body. Returns: slug. Required: workspace_id, tags.

create_a_postman_workspace

Create a new Postman workspace. Returns: id, name, type, visibility, createdBy. The teamId property must be passed in the request body if Postman Organizations is enabled.

get_single_postman_workspace_by_id

Get a single Postman workspace by id. Returns: id, name, type, description, visibility, createdBy, updatedBy, createdAt, updatedAt, about, collections, environments, mocks, monitors, specs, scim. Required: id.

update_a_postman_workspace_by_id

Update a Postman workspace's properties such as its name or visibility. Returns the updated workspace including id, name, type, visibility, description, createdBy. Some visibility changes are not supported on Free and Solo plans; public team workspace names must be unique. Required: id.

delete_a_postman_workspace_by_id

Delete a Postman workspace by id. Returns: workspace. Required: id.

postman_workspaces_list_tags

List all tags associated with a Postman workspace. Returns: slug, id. Required: workspace_id.

list_all_postman_teams

List all Postman teams in your organization. Returns team objects. The response field definitions are defined by the Postman API's Teams_getTeams_Response_200 schema and are not enumerated in the available source documentation. Defaults to 50 results per page.

create_a_postman_team

Create a Postman team in your organization. Returns the created team object. The response field definitions are defined by the Postman API's createGetTeamResponse schema and are not enumerated in the available source documentation.

get_single_postman_team_by_id

Get a Postman team by id. Returns the team object. The response field definitions are defined by the Postman API's createGetTeamResponse schema and are not enumerated in the available source documentation. The optional include query parameter controls whether members and userRoles data are added to the response. Required: id.

list_all_postman_team_access_requests

List a Postman team's pending access requests. Returns the access request objects. Required: team_id.

create_a_postman_team_access_request

Create an access request for a Postman team, such as requesting to join, upgrading a user's role, adding members, or requesting team role access to another team. Returns the created access request object. If team discovery is enabled, the request is automatically approved. Required: team_id, entityList, role, reason, requestType.

postman_team_access_requests_approve_or_deny

Approve or deny a pending access request for a Postman team. Returns the access request object. Required: team_id, request_id, action.

create_a_postman_team_bulk_member

Manage team member roles. Returns: result. Required: team_id.

postman_team_bulk_members_bulk_delete

Remove entities such as users or organizations from a Postman team. Returns an empty 204 response on success. Required: team_id.

list_all_postman_team_settings

Get a Postman team's settings by team ID. Returns: settings. Required: team_id.

postman_team_settings_bulk_update

Update a Postman team's settings. Returns the updated team settings object. Required: team_id.

list_all_postman_users

List all users on a Postman team, optionally filtered by group. Returns: id.

get_single_postman_user_by_id

Get a single Postman team user by id. Returns: id. Required: id.

create_a_postman_webhook

Create a Postman webhook that triggers a collection with a custom payload. Returns: webhook. Required: workspace.

create_a_postman_invitation

Manage Partner Workspace invitations in Postman — send invitations to email addresses, remove partners from a workspace, or remove partners from a partnership and all its workspaces. Returns a successful response confirming the operation result. Partner Workspaces are available on Team and Enterprise plans.

list_all_postman_workspaces_roles

List all workspace roles available in Postman, based on the team's plan. Returns: roles. The available roles may vary depending on the Postman plan tier.

list_all_postman_workspace_activities

List a Postman workspace's activity feed. Returns a paginated list of activity entries describing who added or removed collections, environments, or elements from the workspace, and users who joined or left. Required: workspace_id.

create_a_postman_workspace_element_transfer

Transfer a Postman element — such as a collection, environment, mock, monitor, or Flow — from one workspace to another. Returns: workspace. Does not support transferring elements from team workspaces to personal workspaces. Required: workspace_id, id, type, to.

list_all_postman_workspace_global_variables

List a Postman workspace's global variables. Returns each variable with its key, value, and type. Required: workspace_id.

postman_workspace_global_variables_bulk_update

Update and replace all global variables in a Postman workspace. This endpoint replaces all existing global variables with the variables passed in the request body — any variables not included are removed. Returns: values. Required: workspace_id.

list_all_postman_workspace_roles

List the roles of users, user groups, and partners in a Postman workspace. Returns: roles. Required: workspace_id.

postman_workspace_roles_bulk_update

Update the roles of users, user groups, or partners in a Postman workspace by submitting role operations. Returns: roles. Limited to 50 operations per call; cannot mix partner and user roles in the same request. Required: workspace_id.

postman_workspace_transfers_bulk_update

Transfer a Postman workspace from one team (source) to another (destination). Returns: workspace. Available only on Enterprise plans with Organizations enabled; team user roles may change during transfer. Required: workspace_id, destination, source.

list_all_postman_workspace_updates

Get all workspace updates. Returns: id, topic, description, workspaceId, createdBy, updatedBy, createdAt, updatedAt. Required: workspace_id.

create_a_postman_workspace_update

Create a workspace update. Returns: id, topic, description, workspaceId, createdBy, updatedBy, createdAt, updatedAt. Required: workspace_id, description, topic, category.

update_a_postman_workspace_update_by_id

Update a workspace update. Returns: id, topic, description, workspaceId, createdBy, updatedBy, createdAt, updatedAt. Required: id, workspace_id, description, topic, category.

delete_a_postman_workspace_update_by_id

Delete a workspace update. Required: id, workspace_id.

get_single_postman_workspace_update_by_id

Get a workspace update. Required: id, workspace_id.

update_a_postman_collection_standalone_comment_by_id

Update a comment on a Postman collection. Returns the updated comment object including id, body, and threadId. Accepts a maximum of 10,000 characters. Required: id, collection_id, body.

delete_a_postman_collection_standalone_comment_by_id

Delete a comment from a Postman collection. Returns an empty 204 response on success. Deleting the first comment of a thread deletes all comments in the thread. Required: id, collection_id.

list_all_postman_me

Get information about the authenticated Postman user. Returns: id, sub, username, email, fullName, avatar, isPublic, emailVerified, teamId, teamName, teamDomain, roles. The response differs for Guest and Partner roles; flow_count is only returned for Free plan users.