Postman
Work with Postman collections, environments, APIs, and mock servers. Sign in with Postman to connect.
What Postman exposes.
Every tool below is one this server advertised the last time Omniio refreshed it, under the postman__ namespace. Your agent never loads them all — it searches, and gets the few that match.
postman__addWorkspaceToPrivateNetwork1 argument · 1 required
Publishes a workspace to your team's Private API Network. WARNING: This tool is for Private API Network management, not for general workspace operations. For workspace management use: getWorkspaces, getWorkspace, createWorkspace, updateWorkspace, deleteWorkspace.
Required
workspacepostman__createCollection2 arguments · 1 required
Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** If you do not include the \`workspace\` query parameter, the system creates the collection in the oldest personal Internal workspace you own.
Required
workspacepostman__createCollectionComment4 arguments · 2 required
Creates a comment on a collection. To create a reply on an existing comment, include the \`threadId\` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdbodypostman__createCollectionFolder3 arguments · 1 required
Creates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include the \`requests\` field and the list of request objects in the request body. For more information, see the provided example. **Note:** It is recommended that you pass the \`name\` property in the request body. If you do not, the system uses a null value. As a result, this creates a folder with a blank name.
Required
collectionIdpostman__createCollectionFork3 arguments · 3 required
Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace.
Required
collectionIdworkspacelabelpostman__createCollectionRequest15 arguments · 1 required
Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended that you pass the \`name\` property in the request body. If you do not, the system uses a null value. As a result, this creates a request with a blank name.
Required
collectionIdpostman__createCollectionResponse19 arguments · 2 required
Creates a request response in a collection. For a complete list of request body properties, refer to the **Response** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** It is recommended that you pass the \`name\` property in the request body. If you do not, the system uses a null value. As a result, this creates a response with a blank name.
Required
collectionIdrequestpostman__createEnvironment2 arguments · 1 required
Creates an environment. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP \`411 Length Required\` error response, manually pass the \`Content-Length\` header and its value in the request header. - If you do not include the \`workspace\` query parameter, the system creates the environment in the oldest personal Internal workspace you own.
Required
workspacepostman__createFolderComment5 arguments · 3 required
Creates a comment on a folder. To create a reply on an existing comment, include the \`threadId\` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdfolderIdbodypostman__createMock2 arguments · 1 required
Creates a mock server in a collection. - Pass the collection UID (ownerId-collectionId), not the bare collection ID. - If you only have a \`collectionId\`, resolve the UID first: 1) Prefer GET \`/collections/{collectionId}\` and read \`uid\`, or 2) Construct \`{ownerId}-{collectionId}\` using ownerId from GET \`/me\`: - For team-owned collections: \`ownerId = me.teamId\` - For personal collections: \`ownerId = me.user.id\` - Use the \`workspace\` query to place the mock in a specific workspace. Prefer explicit workspace scoping.
Required
workspacepostman__createMockServerResponse2 arguments · 1 required
Creates a server response on a mock server. Server responses simulate 5xx server-level failures (e.g. 500, 503) that are agnostic to any specific route — when active, every request to the mock returns this response. - \`statusCode\` must be a 5xx value (500–599). - \`body\` is a raw string — pass the response body exactly as the mock should return it (e.g. a JSON string like \`"{\"message\":\"error\"}"\` or plain text). - \`language\` controls syntax highlighting in the Postman UI (\`json\`, \`xml\`, \`html\`, \`javascript\`, \`text\`). It does not affect the actual response Content-Type — set that via \`headers\` instead. - \`headers\` is an array of \`{key, value}\` pairs for response headers (e.g. \`[{"key": "Content-Type", "value": "application/json"}]\`). - You can create multiple server responses per mock, but only one can be active at a time. Creating a response does NOT automatically activate it — call \`updateMock\` with \`config.serverResponseId\` set to the new response's \`id\` to activate it.
Required
mockIdpostman__createMonitor2 arguments · 1 required
Creates a monitor. **Note:** - You cannot create monitors for collections added to an API definition. - If you do not pass the \`workspace\` query parameter, the system creates the monitor in the oldest personal Internal workspace you own.
Required
workspacepostman__createRequestComment5 arguments · 3 required
The request ID must contain the team ID as a prefix, in \`teamId-requestId\` format. For example, if you're creating a comment on collection ID \`24585957-7b2c98f7-30db-4b67-8685-0079f48a0947\` (note on the prefix), and the collection request's ID is \`2c450b59-9bbf-729b-6ac0-f92535a7c336\`, then the \`{requestId}\` must be \`24585957-2c450b59-9bbf-729b-6ac0-f92535a7c336\`.
Required
collectionIdrequestIdbodypostman__createResponseComment5 arguments · 3 required
Creates a comment on a response. To create a reply on an existing comment, include the \`threadId\` property in the request body. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdresponseIdbodypostman__createSpec4 arguments · 4 required
Creates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or multi-file. **Note:** - Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy specifications. - If the file path contains a \`/\` (forward slash) character, then a folder is created. For example, if the path is the \`components/schemas.json\` value, then a \`components\` folder is created with the \`schemas.json\` file inside. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 12 MB in size.
Required
workspaceIdnametypefilespostman__createSpecFile3 arguments · 3 required
Creates a file for an OpenAPI or a protobuf 2 or 3 specification. **Note:** - If the file path contains a \`/\` (forward slash) character, then a folder is created. For example, if the path is the \`components/schemas.json\` value, then a \`components\` folder is created with the \`schemas.json\` file inside. - Creating a spec file assigns it the \`DEFAULT\` file type. - Multi-file specifications can only have one root file. - Files cannot exceed a maximum of 10 MB in size.
Required
specIdpathcontentpostman__createWorkspace1 argument
Creates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/). **Note:** - This endpoint returns a 403 \`Forbidden\` response if the user does not have permission to create workspaces. [Admins and Super Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can configure workspace permissions to restrict users and/or user groups from creating workspaces or require approvals for the creation of team workspaces. - Private and [Partner Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing). - There are rate limits when publishing public workspaces. - Public team workspace names must be unique. - The \`teamId\` property must be passed in the request body if [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) is enabled.
postman__deleteApiCollectionComment3 arguments · 3 required
Deletes a comment from an API's collection. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.
Required
apiIdcollectionIdcommentIdpostman__deleteCollection1 argument · 1 required
Deletes a collection.
Required
collectionIdpostman__deleteCollectionComment2 arguments · 2 required
Deletes a comment from a collection. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.
Required
collectionIdcommentIdpostman__deleteCollectionFolder2 arguments · 2 required
Deletes a folder in a collection.
Required
folderIdcollectionIdpostman__deleteCollectionRequest2 arguments · 2 required
Deletes a request in a collection.
Required
requestIdcollectionIdpostman__deleteCollectionResponse2 arguments · 2 required
Deletes a response in a collection.
Required
responseIdcollectionIdpostman__deleteEnvironment1 argument · 1 required
Deletes an environment.
Required
environmentIdpostman__deleteFolderComment3 arguments · 3 required
Deletes a comment from a folder. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.
Required
collectionIdfolderIdcommentIdpostman__deleteMock1 argument · 1 required
Deletes a mock server. - Resource: Mock server entity. This is destructive. - Ensure you are targeting the correct mock ID.
Required
mockIdpostman__deleteMockServerResponse2 arguments · 2 required
Deletes a server response from a mock server. - If this server response is currently active (\`config.serverResponseId\` on the mock), deleting it will not automatically deactivate it. Call \`updateMock\` with \`config.serverResponseId: null\` first to deactivate. - This action is destructive and cannot be undone.
Required
mockIdserverResponseIdpostman__deleteMonitor1 argument · 1 required
Deletes a monitor.
Required
monitorIdpostman__deleteRequestComment3 arguments · 3 required
Deletes a comment from a request. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.
Required
collectionIdrequestIdcommentIdpostman__deleteResponseComment3 arguments · 3 required
Deletes a comment from a response. On success, this returns an HTTP \`204 No Content\` response. **Note:** Deleting the first comment of a thread deletes all the comments in the thread.
Required
collectionIdresponseIdcommentIdpostman__deleteSpec1 argument · 1 required
Deletes an API specification. On success, this returns an HTTP \`204 No Content\` response.
Required
specIdpostman__deleteSpecFile2 arguments · 2 required
Deletes a file in an API specification. On success, this returns an HTTP \`204 No Content\` response.
Required
specIdfilePathpostman__deleteWorkspace1 argument · 1 required
Deletes an existing workspace.
Required
workspaceIdpostman__duplicateCollection3 arguments · 2 required
Creates a duplicate of the given collection in another workspace. Use the GET \`/collection-duplicate-tasks/{taskId}\` endpoint to get the duplication task's current status.
Required
collectionIdworkspacepostman__generateCollection4 arguments · 4 required
Creates a collection from the given API specification. The specification must already exist or be created before it can be used to generate a collection. The response contains a polling link to the task status.
Required
specIdelementTypenameoptionspostman__generateSpecFromCollection5 arguments · 5 required
Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling link to the task status.
Required
collectionUidelementTypenametypeformatpostman__getAllSpecs3 arguments · 1 required
Gets all API specifications in a workspace.
Required
workspaceIdpostman__getAnalyticsData13 arguments · 2 required
Gets analytics data based on the specified resource, metrics, and given filters for team, internal, and public workspaces, as well as Partner Workspaces. **Note:** This endpoint only accepts the following resource:metric query parameter combinations: - \`user\` — \`workspace_active_users\`, \`active_users\` - \`workspace\` — \`elements_in_workspace\`, \`active_workspaces\`, \`api_calls\`, \`active_collections\`, \`response_status\`, \`pending_invites\`, \`needs_attention\`, \`success_rate\`, \`user_requests\`, \`collection_error_aggregate\` - \`team\` — \`user_api_journey\`, \`workspace_distribution\`, \`internal_workspace_distribution\`, \`license_consumption\`, \`members\`, \`last_autoflex_cycle\`, \`partner_engagement_funnel\` - \`ai\` — \`top_agent_models_by_usage\`, \`activity_distribution\`, \`peak_activity\`, \`usage_leaderboard\`, \`credit_usage_by_model\`, \`messages_sent\`, \`credit_usage\`, \`agent_mode_sessions\`, \`new_vs_returning_users\`, \`agent_mode_users\` The \`view\` query parameter only accepts the following values when called with the following resource:metric pairs: - \`detailed\` or \`summary\` — \`user:active_users\`, \`workspace:active_workspaces\`, \`workspace:pending_invites\`, \`workspace:needs_attention\`, \`workspace:success_rate\`, \`team:partner_engagement_funnel\` \`summary\` only — \`workspace:elements_in_workspace\`, \`workspace:workspace_active_users\`, \`workspace:api_calls\`, \`workspace:response_status\`, \`team:user_api_journey\`, \`team:workspace_distribution\`, \`team:internal_workspace_distribution\`, \`team:license_consumption\` - \`detailed\` only — \`workspace:active_collections\`, \`workspace:user_requests\`
Required
resourcemetricspostman__getAnalyticsMetadata3 arguments
Returns a catalog of analytics resources and their corresponding metrics for use with the GET /analytics endpoint. These metrics provide insights on API usage, success, workspace, and team trends in Postman.
postman__getApiDiscoveryInstructionsno arguments
Returns instructions (markdown) for finding APIs in Postman — searching the public network, browsing private/internal/team collections, filtering by ownership and visibility, and comparing candidate APIs. Includes the rules for presenting results with Postman links and the patterns for evaluating tradeoffs between APIs. Call this when the user wants to find, search for, or compare APIs (e.g., "find me an email API", "search for the Payvance API", "compare Payvance and Cashloom"). Prerequisite: call getPostmanContextOverview first if you have not already loaded the Postman Context overview in this session.
postman__getAsyncSpecTaskStatus3 arguments · 3 required
Gets the status of an asynchronous API specification creation task.
Required
elementTypeelementIdtaskIdpostman__getAuthenticatedUserno arguments
Gets information about the authenticated user. - This endpoint provides “current user” context (\`user.id\`, \`username\`, \`teamId\`, roles). - When a user asks for “my …” (e.g., “my workspaces, my information, etc.”), call this first to resolve the user ID.
postman__getCodeGenerationInstructionsno arguments
Returns the full workflow instructions for discovering APIs, exploring collections, and generating client code from Postman. Includes step-by-step guidance, tool usage patterns, and code generation rules. MANDATORY: You MUST call this tool when the user says to "use postman", or when the user wants to do something that requires locating a specific API for the purpose of answering questions, planning a build, and in most cases proceeding to generate code that calls the API. ALWAYS call getCodeGenerationInstructions BEFORE calling other tools in this workflow. This tool returns comprehensive step-by-step instructions on how to search for APIs, gather API-specific context from other tools, and then generate client code based on the context retrieved.
postman__getCollection3 arguments · 1 required
Get information about a collection. By default this tool returns the lightweight collection map (metadata + recursive itemRefs). Use the model parameter to opt in to Postman's full API responses: - model=minimal — root-level folder/request IDs only - model=full — full Postman collection payload.
Required
collectionIdpostman__getCollectionComments1 argument · 1 required
Gets all comments left by users in a collection.
Required
collectionIdpostman__getCollectionFolder5 arguments · 2 required
Gets information about a folder in a collection.
Required
folderIdcollectionIdpostman__getCollectionForks4 arguments · 1 required
Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user who forked it, and the fork's creation date.
Required
collectionIdpostman__getCollectionRequest5 arguments · 2 required
Gets information about a request in a collection.
Required
requestIdcollectionIdpostman__getCollectionResponse5 arguments · 2 required
Gets information about a response in a collection.
Required
responseIdcollectionIdpostman__getCollectionTags1 argument · 1 required
Gets all the tags associated with a collection.
Required
collectionIdpostman__getCollectionUpdatesTasks1 argument · 1 required
Gets the status of an asynchronous collection update task.
Required
taskIdpostman__getCollections4 arguments · 1 required
The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.
Required
workspacepostman__getCollectionsForkedByUser3 arguments
Gets a list of all the authenticated user's forked collections.
postman__getDuplicateCollectionTaskStatus1 argument · 1 required
Gets the status of a collection duplication task.
Required
taskIdpostman__getEnabledToolsno arguments
IMPORTANT: Run this tool first when a requested tool is unavailable. Returns information about which tools are enabled in the full and minimal tool sets, helping you identify available alternatives.
postman__getEnvironment1 argument · 1 required
Gets information about an environment.
Required
environmentIdpostman__getEnvironments1 argument
Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
postman__getFolderComments2 arguments · 2 required
Gets all comments left by users in a folder.
Required
collectionIdfolderIdpostman__getGeneratedCollectionSpecs2 arguments · 2 required
Gets the API specification generated for the given collection.
Required
collectionUidelementTypepostman__getInstalledApiMaintenanceInstructionsno arguments
Returns instructions (markdown) for maintaining the API requests already installed in the user's project — listing installed requests, checking installed requests against their Postman sources for upstream changes, finding unused requests, and safely removing installed requests. Installed requests are identifiable by a "Generated by Postman Code" comment in the file header. Call this when the user wants to manage existing integrations (e.g., "what requests do we have installed?", "are my API integrations up to date?", "find unused Postman requests", "remove the Payvance requests"). Prerequisite: call getPostmanContextOverview first if you have not already loaded the Postman Context overview in this session.
postman__getMock1 argument · 1 required
Gets information about a mock server. - Resource: Mock server entity. Response includes the associated \`collection\` UID and \`mockUrl\`. - Use the \`collection\` UID to navigate back to the source collection.
Required
mockIdpostman__getMockServerResponse2 arguments · 2 required
Gets the full details of a specific server response, including its \`body\`, \`headers\`, and \`language\`. - Use \`getMockServerResponses\` first to list available server response IDs. - To check which response is active, call \`getMock\` and read \`config.serverResponseId\`.
Required
mockIdserverResponseIdpostman__getMockServerResponses1 argument · 1 required
Gets all server responses configured for a mock server. - Server responses simulate 5xx server-level failures (e.g. 500, 503) independently of any specific route or example. - This endpoint returns summary metadata only (id, name, statusCode, timestamps). To get the full body and headers of a specific response, call \`getMockServerResponse\` with the response's \`id\`. - To see which server response is currently active, call \`getMock\` and check \`config.serverResponseId\`.
Required
mockIdpostman__getMocks2 arguments
Gets all active mock servers. By default, returns only mock servers you created across all workspaces. - Always pass either the \`workspace\` or \`teamId\` query to scope results. Prefer \`workspace\` when known. - If you need team-scoped results, set \`teamId\` from the current user: call GET \`/me\` and use \`me.teamId\`. - If both \`teamId\` and \`workspace\` are passed, only \`workspace\` is used.
postman__getMonitor1 argument · 1 required
Gets information about a monitor.
Required
monitorIdpostman__getMonitorRunResults2 arguments · 2 required
Gets results for a monitor run, including trimmed execution logs (beforeItem and assertion events only) and result counts. Use this to inspect per-request assertions and failure details for a specific run. This is Step 3 of the monitor-run workflow: listMonitorExecutions → listRunsForExecution → getMonitorRunResults. The runId must come from listRunsForExecution — do NOT use an executionId here, it will return 404.
Required
monitorIdrunIdpostman__getMonitors7 arguments
Gets all monitors.
postman__getPostmanContextOverviewno arguments
Returns the Postman Context overview (markdown). Explains the core concepts (workspaces, collections, requests, installed code) and the end-to-end workflow for finding APIs, generating client code, and maintaining installed requests over time. Call this FIRST — and only — when the user wants to explore APIs in Postman's network, answer questions about how an API works, plan an integration, or generate client code grounded in real Postman API definitions, AND you have not already loaded the overview in this session. Do NOT call this for routine Postman operations like listing or editing workspaces, collections, environments, mocks, monitors, or specs — go straight to the relevant resource tool. After reading the overview, route to the appropriate topic-specific instructions tool: getApiDiscoveryInstructions (find/search/compare APIs), getCodeGenerationInstructions (generate client code from a request), or getInstalledApiMaintenanceInstructions (list, update, or remove installed requests).
postman__getRequestComments2 arguments · 2 required
Gets all comments left by users in a request.
Required
collectionIdrequestIdpostman__getResponseComments2 arguments · 2 required
Gets all comments left by users in a response.
Required
collectionIdresponseIdpostman__getSourceCollectionStatus1 argument · 1 required
Checks whether there is a change between the forked collection and its parent (source) collection. If the value of the \`isSourceAhead\` property is \`true\` in the response, then there is a difference between the forked collection and its source collection. **Note:** This endpoint may take a few minutes to return an updated \`isSourceAhead\` status.
Required
collectionIdpostman__getSpec1 argument · 1 required
Gets information about an API specification.
Required
specIdpostman__getSpecCollections4 arguments · 2 required
Gets all of an API specification's generated collections.
Required
specIdelementTypepostman__getSpecDefinition1 argument · 1 required
Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.
Required
specIdpostman__getSpecFile2 arguments · 2 required
Gets the contents of an API specification's file.
Required
specIdfilePathpostman__getSpecFiles1 argument · 1 required
Gets all the files in an API specification.
Required
specIdpostman__getStatusOfAnAsyncApiTask3 arguments · 3 required
Gets the status of an asynchronous task.
Required
apiIdtaskIdAcceptpostman__getTaggedEntities5 arguments · 1 required
**Requires an Enterprise plan.** Tagging is only available on Postman Enterprise plans. This tool returns a 404 error on Free, Basic, and Professional accounts. Gets Postman elements (entities) by a given tag. Tags enable you to organize and search workspaces, APIs, and collections that contain shared tags.
Required
slugpostman__getWorkspace2 arguments · 1 required
Gets information about a workspace. **Note:** This endpoint's response contains the \`visibility\` field. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility) determines who can access the workspace: - \`personal\` — Only you can access the workspace. - \`team\` — All team members can access the workspace. - \`private\` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)). - \`public\` — Everyone can access the workspace. - \`partner\` — Only invited team members and [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
Required
workspaceIdpostman__getWorkspaceGlobalVariables1 argument · 1 required
Gets a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). Global variables enable you to access data between collections, requests, scripts, and environments and are available throughout a workspace.
Required
workspaceIdpostman__getWorkspaceTags1 argument · 1 required
Gets all the tags associated with a workspace.
Required
workspaceIdpostman__getWorkspaces7 arguments
Gets all workspaces you have access to. - For “my …” requests, first call GET \`/me\` and pass \`createdBy={me.user.id}\`. - This endpoint's response contains the visibility field. Visibility determines who can access the workspace: - \`personal\` — Only you can access the workspace. - \`team\` — All team members can access the workspace. - \`private\` — Only invited team members can access the workspace (Professional and Enterprise). - \`public\` — Everyone can access the workspace. - \`partner\` — Invited team members and partners (Professional and Enterprise). - For tools that require the workspace ID, and no workspace ID is provided, ask the user to provide the workspace ID. If the user does not provide the workspace ID, call this first with the createdBy parameter to use the first workspace. - Results are paginated. Use the \`cursor\` parameter to retrieve additional pages. - Examples: - “List my workspaces” → GET \`/me\`, then GET \`/workspaces?createdBy={me.user.id}&limit=100\` - “List my personal workspaces” → GET \`/me\`, then GET \`/workspaces?type=personal&createdBy={me.user.id}&limit=100\` - “List all public workspaces” → GET \`/workspaces?type=public&limit=100\`
postman__listMonitorExecutions2 arguments · 1 required
Lists executions for a monitor. Cursor-based pagination, 25 results per page. Returns execution metadata including state, trigger, results summary, and timestamps. This is Step 1 of the monitor-run workflow: listMonitorExecutions → listRunsForExecution → getMonitorRunResults. Each execution has an `id` (executionId). To get run results, you must first pass this executionId to listRunsForExecution to obtain run IDs — do NOT use executionId as a runId.
Required
monitorIdpostman__listPrivateNetworkAddRequests10 arguments
Gets all requests to add workspaces to your team's Private API Network. WARNING: This tool is for Private API Network management, not for general workspace operations. For workspace management use: getWorkspaces, getWorkspace, createWorkspace, updateWorkspace, deleteWorkspace.
postman__listPrivateNetworkWorkspaces13 arguments
Gets information about workspaces added to your team's Private API Network. WARNING: This tool is for Private API Network management, not for general workspace operations. For workspace management use: getWorkspaces, getWorkspace, createWorkspace, updateWorkspace, deleteWorkspace.
postman__listRunsForExecution2 arguments · 2 required
Lists runs for a monitor execution. Each execution may produce multiple runs across regions. Returns run metadata including region, state, result counts, and timestamps. Not paginated. This is Step 2 of the monitor-run workflow: listMonitorExecutions → listRunsForExecution → getMonitorRunResults. Pass the executionId from listMonitorExecutions. Returns run objects whose `id` is the runId needed by getMonitorRunResults.
Required
monitorIdexecutionIdpostman__mergeCollectionFork3 arguments · 2 required
**This endpoint is deprecated.** Merges a forked collection back into its parent collection. You must have the [Editor role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for the collection to merge a fork.
Required
destinationsourcepostman__patchCollection2 arguments · 1 required
Updates specific collection information, such as its name, events, or its variables. For more information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Important usage notes:** - **Sequential calls only.** Do NOT call \`patchCollection\` in parallel with other \`patchCollection\` calls for the same collection — concurrent PATCH requests conflict with each other and cause cancellation errors. Always wait for one call to complete before making another. - **Partial updates.** Only include the fields you want to change. Omit all other fields entirely; unspecified fields are left unchanged. - **Variables (\`collection.variable\`).** When updating variables, provide only the fields you intend to set on each variable object (\`key\`, \`value\`, \`description\`). Omit \`id\` and \`disabled\` unless you explicitly need to change them — including extra fields can cause validation errors.
Required
collectionIdpostman__patchEnvironment2 arguments · 2 required
Updates specific environment properties, such as its name and variables. **Note:** - You can only perform one type of operation at a time. For example, you cannot perform an \`add\` and \`replace\` operation in the same call. - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP \`411 Length Required\` error response, manually pass the \`Content-Length\` header and its value in the request header. - To add a description to an existing variable, use the \`add\` operation.
Required
environmentIdbodypostman__publishDocumentation5 arguments · 3 required
Publishes a collection's documentation. This makes it publicly available to anyone with the link to the documentation. **Note:** - Your [Postman plan](https://www.postman.com/pricing/) impacts your use of these endpoints: - For **Free** and **Solo** users, you must have permissions to edit the collection. - If [API Governance and Security](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/) is enabled for your [**Enterprise**](https://www.postman.com/pricing/) team, only users with the [Community Manager role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can publish documentation. - Publishing is only supported for collections with HTTP requests. - You cannot publish a collection added to an API.
Required
collectionIdcustomColorcustomizationpostman__publishMock1 argument · 1 required
Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.
Required
mockIdpostman__pullCollectionChanges1 argument · 1 required
Pulls the changes from a parent (source) collection into the forked collection. In the endpoint's response: - The \`destinationId\` is the ID of the forked collection. - The \`sourceId\` is the ID of the source collection.
Required
collectionIdpostman__putCollection3 arguments · 1 required
Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection's ID values in the request body. If you do not, the endpoint removes the existing items and creates new items. - To perform an update asynchronously, use the \`Prefer\` header with the \`respond-async\` value. When performing an async update, this endpoint returns a HTTP \`202 Accepted\` response. - For a complete list of properties and information, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). - For protocol profile behavior, refer to Postman's [Protocol Profile Behavior documentation](https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md). **Note:** - The maximum collection size this endpoint accepts cannot exceed 100 MB. - Use the GET \`/collection-updates-tasks/{taskId}\` endpoint to get the collection's update status when performing an asynchronous update. - If you don't include the collection items' ID values from the request body, the endpoint **removes** the existing items and recreates the items with new ID values. - To copy another collection's contents to the given collection, remove all ID values before you pass it in this endpoint. If you do not, this endpoint returns an error. These values include the \`id\`, \`uid\`, and \`postman_id\` values.
Required
collectionIdpostman__putEnvironment2 arguments · 1 required
Replaces all the contents of an environment with the given information. **Note:** - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP \`411 Length Required\` error response, manually pass the \`Content-Length\` header and its value in the request header.
Required
environmentIdpostman__removeWorkspaceFromPrivateNetwork1 argument · 1 required
Removes a workspace from your team's Private API Network. This does not delete the workspace itself — it only removes it from the Private API Network folder. WARNING: This tool is for Private API Network management, not for general workspace operations. For workspace management use: getWorkspaces, getWorkspace, createWorkspace, updateWorkspace, deleteWorkspace.
Required
workspaceIdpostman__resolveCommentThread1 argument · 1 required
Resolves a comment and any associated replies. On success, this returns an HTTP \`204 No Content\` response. Comment thread IDs return in the GET \`/comments\` response for [collections](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-a6582e0a-9382-4760-8b91-53a8aa6cb8d7) and [collection items](https://www.postman.com/postman/workspace/postman-public-workspace/folder/12959542-efeda219-66e1-474c-a83b-253d15723bf7).
Required
threadIdpostman__respondPrivateNetworkAddRequest3 arguments · 2 required
Responds to a user's request to add a workspace to your team's Private API Network. Only managers can approve or deny a request. Once approved, the workspace will appear in the team's Private API Network. WARNING: This tool is for Private API Network management, not for general workspace operations. For workspace management use: getWorkspaces, getWorkspace, createWorkspace, updateWorkspace, deleteWorkspace.
Required
requestIdstatuspostman__runMonitor2 arguments · 1 required
Runs a monitor and returns its run results. **Note:** - If you pass the \`async=true\` query parameter, the response does not return the \`stats\`, \`executions\`, and \`failures\` responses. To get this information for an asynchronous run, call the GET \`/monitors/{id}\` endpoint. - If the call exceeds 300 seconds, the endpoint returns an HTTP \`202 Accepted\` response. Use the GET \`/monitors/{id}\` endpoint to check the run's status in the response's \`lastRun\` property. To avoid this, it is recommended that you include the \`async=true\` query parameter when using this endpoint.
Required
monitorIdpostman__searchLearningCenter1 argument · 1 required
Search the official Postman documentation and learning resources at https://learning.postman.com. Use this tool when you need authoritative, up-to-date guidance on how to use Postman features — for example creating mock servers, writing tests, using environments, configuring monitors, or any "how do I…" question about the Postman product. Returns relevant documentation passages with their source URLs. Do not use this tool to search a user's own Postman resources (collections, workspaces, specs) — use `searchPostmanElements` for that.
Required
querypostman__searchPostmanElements6 arguments
Search for Postman entities (requests, collections, workspaces, specs, flows, environments, and mocks). **Ownership:** - `organization` — Search within all resources owned by your organization (default). - `external` — Search within the public Postman network (third-party and community APIs). - `all` — Search across all scopes. **When to use each ownership value and filters:** | Goal | Recommended approach | |------|----------------------| | Find an internal API (e.g. "our notification service") | `ownership: organization` | | Find a trusted API published to the Private Network | `ownership: organization` + `privateNetwork: true` filter | | Find an internal API in all resources of organization and are visible to the organization only | `ownership: organization` + `visibility: internal` filter | | Find an API by your organization that is made publicly visible | `ownership: organization` + `visibility: public` filter | | Find a third party publicly visible API (e.g. "Stripe API", "Twilio API") | `ownership: external` + `visibility: public` filter | | User says "our APIs", "internal", "team" | `ownership: organization` | | Search across all scopes | `ownership: all` | **Element Types:** - `requests`: Search for individual API requests. - `collections`: Search for API collections. - `workspaces`: Search for Postman workspaces. - `specs`: Search for API specifications. - `flows`: Search for Postman Flows. - `environments`: Search for Postman Environments. - `mocks`: Search for Postman Mock Servers. **Filters:** Use the `filters` parameter to narrow results. The top-level key must be `$and` with an array of condition objects. Each condition object must contain exactly one field key. Supported filter fields: | Field | Operators | Notes | |-------|-----------|-------| | `workspaceId` | `$eq`, `$ne`, `$in`, `$nin` | All element types. `$in`/`$nin` accept arrays. | | `collectionId` | `$eq`, `$ne`, `$in`, `$nin` | Requests and collections only. | | `visibility` | `$eq`, `$ne` | Values: `public`, `partner`, `internal`. All element types. | | `privateNetwork` | `$eq`, `$ne` | Boolean. All element types. | | `publisherIsVerified` | `$eq`, `$ne` | Boolean. All element types. | | `method` | `$eq`, `$ne`, `$in`, `$nin` | HTTP methods (GET, POST, etc.). Requests only. | | `tags` | `$eq`, `$ne`, `$in`, `$nin` | Workspaces and collections only. | | `requestId` | `$eq`, `$ne`, `$in`, `$nin` | Requests only. | | `specificationId` | `$eq`, `$ne`, `$in`, `$nin` | Specs only. | | `flowId` | `$eq`, `$ne`, `$in`, `$nin` | Flows only. | | `createdBy` | `$eq`, `$ne`, `$in`, `$nin` | All element types. | | `organizationId` | `$eq`, `$ne`, `$in`, `$nin` | All element types. | | `teamId` | `$eq`, `$ne`, `$in`, `$nin` | All element types. | | `isGitConnected` | `$eq`, `$ne` | Boolean. Workspaces, collections, requests, specs, flows, environments, mocks. | | `type` | `$eq`, `$ne`, `$in`, `$nin` | Requests only. | **Filter examples:** - Private API Network only: `{"$and":[{"privateNetwork":{"$eq":true}}]}` - Single workspace: `{"$and":[{"workspaceId":{"$eq":"ws-abc123"}}]}` - Multiple workspaces: `{"$and":[{"workspaceId":{"$in":["ws-1","ws-2"]}}]}` - Public visibility: `{"$and":[{"visibility":{"$eq":"public"}}]}` - GET requests only: `{"$and":[{"method":{"$eq":"GET"}}]}` - Combine conditions: `{"$and":[{"visibility":{"$eq":"public"}},{"workspaceId":{"$eq":"ws-abc123"}}]}` - Environments in a workspace: `{"$and":[{"workspaceId":{"$eq":"ws-abc123"}}]}`
postman__syncCollectionWithSpec2 arguments · 2 required
Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP \`202 Accepted\` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given spec ID.
Required
collectionUidspecIdpostman__syncSpecWithCollection2 arguments · 2 required
Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP \`202 Accepted\` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given specification ID.
Required
specIdcollectionUidpostman__transferCollectionFolders4 arguments · 4 required
Copies or moves folders into a collection or folder.
Required
idsmodetargetlocationpostman__transferCollectionRequests4 arguments · 4 required
Copies or moves requests into a collection or folder.
Required
idsmodetargetlocationpostman__transferCollectionResponses4 arguments · 4 required
Copies or moves responses into a request.
Required
idsmodetargetlocationpostman__unpublishDocumentation1 argument · 1 required
Unpublishes a collection's documentation. On success, this returns an HTTP \`204 No Content\` response.
Required
collectionIdpostman__unpublishMock1 argument · 1 required
Unpublishes a mock server. Unpublishing a mock server sets its **Access Control** configuration setting to private.
Required
mockIdpostman__updateApiCollectionComment5 arguments · 4 required
Updates a comment on an API's collection. **Note:** This endpoint accepts a max of 10,000 characters.
Required
apiIdcollectionIdcommentIdbodypostman__updateCollectionComment4 arguments · 3 required
Updates a comment on a collection. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdcommentIdbodypostman__updateCollectionFolder4 arguments · 2 required
Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the \`name\` property). The endpoint does not update the entire resource.
Required
folderIdcollectionIdpostman__updateCollectionRequest15 arguments · 2 required
Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - You must pass a collection ID (\`12ece9e1-2abf-4edc-8e34-de66e74114d2\`), not a collection(\`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2\`), in this endpoint. - This endpoint does not support changing the folder of a request. - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body.
Required
requestIdcollectionIdpostman__updateCollectionResponse19 arguments · 2 required
Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). **Note:** - You must pass a collection ID (\`12ece9e1-2abf-4edc-8e34-de66e74114d2\`), not a collection UID (\`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2\`), in this endpoint. - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for example, the \`name\` property). The endpoint does not update the entire resource.
Required
responseIdcollectionIdpostman__updateCollectionTags2 arguments · 2 required
Updates a collection's associated tags. This endpoint replaces all existing tags with those you pass in the request body.
Required
collectionIdtagspostman__updateFolderComment5 arguments · 4 required
Updates a comment on a folder. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdfolderIdcommentIdbodypostman__updateMock2 arguments · 1 required
Updates a mock server. - Resource: Mock server entity associated with a collection UID. - Use this to change name, environment, privacy, or default server response. - To activate a server response, set \`config.serverResponseId\` to the server response's \`id\`. Pass \`null\` to deactivate.
Required
mockIdpostman__updateMockServerResponse3 arguments · 2 required
Updates a server response's name, statusCode, body, headers, or language. - \`statusCode\` must remain a 5xx value (500–599). - \`body\` is the raw response body string. Pass the full desired body — this is a full replacement, not a partial update. - Updating a server response does not change which response is active. To activate it, call \`updateMock\` with \`config.serverResponseId\`.
Required
mockIdserverResponseIdpostman__updateMonitor2 arguments · 1 required
Updates a monitor's [configurations](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#configure-a-monitor).
Required
monitorIdpostman__updateRequestComment5 arguments · 4 required
Updates a comment on a request. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdrequestIdcommentIdbodypostman__updateResponseComment5 arguments · 4 required
Updates a comment on a response. **Note:** This endpoint accepts a max of 10,000 characters.
Required
collectionIdresponseIdcommentIdbodypostman__updateSpecFile5 arguments · 2 required
Updates a file for an OpenAPI or protobuf 2 or 3 specification. **Note:** - This endpoint does not accept an empty request body. You must pass one of the accepted values. - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass both the \`content\` and \`type\` property at the same time. - Multi-file specifications can only have one root file. - When updating a file type to \`ROOT\`, the previous root file is updated to the \`DEFAULT\` file type. - Files cannot exceed a maximum of 10 MB in size.
Required
specIdfilePathpostman__updateSpecProperties2 arguments · 2 required
Updates an API specification's properties, such as its name.
Required
specIdnamepostman__updateWorkspace2 arguments · 1 required
Updates a workspace's property, such as its name or visibility. **Note:** - This endpoint does not support the following visibility changes: - \`private\` to \`public\`, \`public\` to \`private\`, and \`private\` to \`personal\` for **Free** and **Solo** [plans](https://www.postman.com/pricing/). - \`public\` to \`personal\` for team users only. - There are rate limits when publishing public workspaces. - Public team workspace names must be unique.
Required
workspaceIdpostman__updateWorkspaceGlobalVariables2 arguments · 1 required
Updates and replaces a workspace's global [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint replaces all existing global variables with the variables you pass in the request body.
Required
workspaceIdpostman__updateWorkspaceTags2 arguments · 2 required
Updates a workspace's associated tags. This endpoint replaces all existing tags with those you pass in the request body.
Required
workspaceIdtags
Three steps, and the last one is not yours.
Point a client at Omniio
One URL, authorized once by your client. If you already use Omniio, this step is done.
Switch Postman on
Authorize it from your library; the grant is yours and stays yours.
Ask for what you need
The agent searches, reads the one schema it picked, and runs it. You do not name the tool.
claude mcp add --transport http omniio https://mcp.omniio.dev
