Postman MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'postmanmcp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Postman MCP:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'postmanmcp_createworkspace',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "postmanmcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Postman MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="postmanmcp_createworkspace",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Updateworkspace records — Updates a workspace’s property, such as its name or visibility
• Updatespecproperties records — Updates an API specification’s properties, such as its name
• Updatespecfile records — Updates a file for an OpenAPI or protobuf 2 or 3 specification
• Updatemock records — Updates a mock server
• Updatecollectionrequest records — Updates a request in a collection
• Syncspecwithcollection records — Syncs an API specification linked to a collection

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

postmanmcp_createcollection#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.2 params▾

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.

NameTypeRequiredDescription

workspacestringrequiredThe workspace's ID.

collectionobjectoptionalNo description.

postmanmcp_createcollectionrequest#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.15 params▾

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.

NameTypeRequiredDescription

collectionIdstringrequiredThe collection's ID.

authstringoptionalThe request's authentication information.

datastringoptionalThe request body's form data.

dataModestringoptionalThe request body's data mode.

dataOptionsstringoptionalAdditional configurations and options set for the request body's various data modes.

descriptionstringoptionalThe request's description.

eventsstringoptionalA list of scripts configured to run when specific events occur.

folderIdstringoptionalThe folder ID in which to create the request. By default, the system will create the request at the collection level.

graphqlModeDatastringoptionalThe request body's GraphQL mode data.

headerDataarrayoptionalThe request's headers.

methodstringoptionalThe request's HTTP method.

namestringoptionalThe request's name. 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.

queryParamsarrayoptionalThe request's query parameters.

rawModeDatastringoptionalThe request body's raw mode data.

urlstringoptionalThe request's URL.

postmanmcp_createcollectionresponse#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.19 params▾

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.

NameTypeRequiredDescription

collectionIdstringrequiredThe collection's ID.

requeststringrequiredThe parent request's ID.

cookiesstringoptionalThe response's cookie data.

dataModestringoptionalThe associated request body's data mode.

dataOptionsstringoptionalAdditional configurations and options set for the request body's various data modes.

descriptionstringoptionalThe response's description.

headersarrayoptionalA list of headers.

languagestringoptionalThe response body's language type.

methodstringoptionalThe request's HTTP method.

mimestringoptionalThe response's MIME type.

namestringoptionalThe response's name. 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.

rawDataTypestringoptionalThe response's raw data type.

rawModeDatastringoptionalThe associated request body's raw mode data.

requestObjectstringoptionalA JSON-stringified representation of the associated request.

responseCodeobjectoptionalThe response's HTTP response code information.

statusstringoptionalThe response's HTTP status text.

textstringoptionalThe raw text of the response body.

timestringoptionalThe time taken by the request to complete, in milliseconds.

urlstringoptionalThe associated request's URL.

postmanmcp_createenvironment#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.2 params▾

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.

NameTypeRequiredDescription

workspacestringrequiredThe workspace's ID.

environmentobjectoptionalInformation about the environment.

postmanmcp_createmock#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.2 params▾

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.

NameTypeRequiredDescription

workspacestringrequiredThe workspace's ID.

mockobjectoptionalNo description.

postmanmcp_createspec#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.4 params▾

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.

NameTypeRequiredDescription

filesarrayrequiredA list of the specification's files and their contents.

namestringrequiredThe specification's name.

typestringrequiredThe type of API specification.

workspaceIdstringrequiredThe workspace's ID.

postmanmcp_createspecfile#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.3 params▾

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.

NameTypeRequiredDescription

contentstringrequiredThe file's stringified contents.

pathstringrequiredThe file's path. Accepts JSON or YAML files.

specIdstringrequiredThe spec's ID.

postmanmcp_createworkspace#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.1 param▾

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.

NameTypeRequiredDescription

workspaceobjectoptionalInformation about the workspace.

postmanmcp_duplicatecollection#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.3 params▾

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.

NameTypeRequiredDescription

collectionIdstringrequiredThe collection's unique ID.

workspacestringrequiredThe workspace ID in which to duplicate the collection.

suffixstringoptionalAn optional suffix to append to the duplicated collection's name.

postmanmcp_generatecollection#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.4 params▾

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.

NameTypeRequiredDescription

elementTypestringrequiredThe `collection` element type.

namestringrequiredThe generated collection's name.

optionsobjectrequiredThe advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive.

specIdstringrequiredThe spec's ID.

postmanmcp_generatespecfromcollection#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.5 params▾

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.

NameTypeRequiredDescription

collectionUidstringrequiredThe collection's unique ID.

elementTypestringrequiredThe `spec` value.

formatstringrequiredThe format of the API specification.

namestringrequiredThe API specification's name.

typestringrequiredThe specification's type.

postmanmcp_getallspecs#Gets all API specifications in a workspace.3 params▾

Gets all API specifications in a workspace.

NameTypeRequiredDescription

workspaceIdstringrequiredThe workspace's ID.

cursorstringoptionalThe pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.

limitintegeroptionalThe maximum number of rows to return in the response.

postmanmcp_getauthenticateduser#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.0 params▾

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.

postmanmcp_getcollection#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.3 params▾

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.

NameTypeRequiredDescription

collectionIdstringrequiredThe collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).

access_keystringoptionalA collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.

modelstringoptionalOptional response shape override. Omit to receive the lightweight collection map. Set to `minimal` for the Postman minimal model or `full` for the complete collection payload.

postmanmcp_getcollections#The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.4 params▾

The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.

NameTypeRequiredDescription

workspacestringrequiredThe workspace's ID.

limitintegeroptionalThe maximum number of rows to return in the response.

namestringoptionalFilter results by collections whose name exactly matches the given value. Partial or substring matches are not supported.

offsetintegeroptionalThe zero-based offset of the first item to return.

postmanmcp_getduplicatecollectiontaskstatus#Gets the status of a collection duplication task.1 param▾

Gets the status of a collection duplication task.

NameTypeRequiredDescription

taskIdstringrequiredThe task's unique ID.

postmanmcp_getenabledtools#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.0 params▾

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.

postmanmcp_getenvironment#Gets information about an environment.1 param▾

Gets information about an environment.

NameTypeRequiredDescription

environmentIdstringrequiredThe environment's ID.

postmanmcp_getenvironments#Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).1 param▾

Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).

NameTypeRequiredDescription

workspacestringoptionalThe workspace's ID.

postmanmcp_getgeneratedcollectionspecs#Gets the API specification generated for the given collection.2 params▾

Gets the API specification generated for the given collection.

NameTypeRequiredDescription

collectionUidstringrequiredThe collection's unique ID.

elementTypestringrequiredThe `spec` value.

postmanmcp_getmock#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.1 param▾

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.

NameTypeRequiredDescription

mockIdstringrequiredThe mock's ID.

postmanmcp_getmocks#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.2 params▾

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.

NameTypeRequiredDescription

teamIdstringoptionalReturn only results that belong to the given team ID. - For team-scoped requests, set this from GET `/me` (`me.teamId`).

workspacestringoptionalReturn only results found in the given workspace ID. - Prefer this parameter when the user mentions a specific workspace.

postmanmcp_getspec#Gets information about an API specification.1 param▾

Gets information about an API specification.

NameTypeRequiredDescription

specIdstringrequiredThe spec's ID.

postmanmcp_getspeccollections#Gets all of an API specification's generated collections.4 params▾

Gets all of an API specification's generated collections.

NameTypeRequiredDescription

elementTypestringrequiredThe `collection` element type.

specIdstringrequiredThe spec's ID.

cursorstringoptionalThe pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.

limitintegeroptionalThe maximum number of rows to return in the response.

postmanmcp_getspecdefinition#Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.1 param▾

Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.

NameTypeRequiredDescription

specIdstringrequiredThe spec's ID.

postmanmcp_getspecfile#Gets the contents of an API specification's file.2 params▾

Gets the contents of an API specification's file.

NameTypeRequiredDescription

filePathstringrequiredThe path to the file.

specIdstringrequiredThe spec's ID.

postmanmcp_getspecfiles#Gets all the files in an API specification.1 param▾

Gets all the files in an API specification.

NameTypeRequiredDescription

specIdstringrequiredThe spec's ID.

postmanmcp_gettaggedentities#**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.5 params▾

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

NameTypeRequiredDescription

slugstringrequiredThe tag's ID within a team or individual (non-team) user scope.

cursorstringoptionalThe cursor to get the next set of results in the paginated response. If you pass an invalid value, the API only returns the first set of results.

directionstringoptionalThe ascending (`asc`) or descending (`desc`) order to sort the results by, based on the time of the entity's tagging.

entityTypestringoptionalFilter results for the given entity type.

limitintegeroptionalThe maximum number of tagged elements to return in a single call.

postmanmcp_getworkspace#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)).2 params▾

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

NameTypeRequiredDescription

workspaceIdstringrequiredThe workspace's ID.

includestringoptionalInclude the following information in the endpoint's response: - `mocks:deactivated` — Include all deactivated mock servers in the response. - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.

postmanmcp_getworkspaces#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\`7 params▾

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\`

NameTypeRequiredDescription

createdByintegeroptionalReturn only workspaces created by the specified Postman user ID. - For “my …” requests, set `createdBy` to the current user’s ID from GET `/me` (`me.user.id`). - If the user's ID is not known, first call GET `/me`, then retry with `createdBy`.

cursorstringoptionalThe cursor to get the next set of results in a paginated response. Get this value from the `meta.nextCursor` field in the previous response.

elementIdstringoptionalFilter results to return the workspace where the given element's ID is located. When filtering by collection, you must use the collection's unique ID (`userId`-`collection`). If you pass this query parameter, you must also pass the `elementType` query parameter.

elementTypestringoptionalFilter results to return the workspace where the given element type is located. If you pass this query parameter, you must also pass the `elementId` query parameter.

includestringoptionalInclude the following information in the endpoint's response: - `mocks:deactivated` — Include all deactivated mock servers in the response. - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.

limitintegeroptionalThe maximum number of workspaces to return per page. Defaults to 100.

typestringoptionalThe type of workspace to filter the response by. One of: `personal`, `team`, `private`, `public`, `partner`. - For “my …” requests, this can be combined with `createdBy`. If type is not specified, it will search across all types for that user.

postmanmcp_publishmock#Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.1 param▾

Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.

NameTypeRequiredDescription

mockIdstringrequiredThe mock's ID.

postmanmcp_putcollection#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.3 params▾

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.

NameTypeRequiredDescription

collectionIdstringrequiredThe collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).

collectionobjectoptionalNo description.

PreferstringoptionalThe `respond-async` header to perform the update asynchronously.

postmanmcp_putenvironment#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.2 params▾

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.

NameTypeRequiredDescription

environmentIdstringrequiredThe environment's ID.

environmentobjectoptionalInformation about the environment.

postmanmcp_searchpostmanelements#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"}}]}`6 params▾

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"}}]}`

NameTypeRequiredDescription

cursorstringoptionalThe cursor to get the next set of results in the paginated response. Pass the `nextCursor` value from the previous response.

entityTypestringoptionalThe type of Postman entity to search for: `requests` (individual API requests), `collections` (API collections), `workspaces` (Postman workspaces), `specs` (API specifications), `flows` (Postman Flows), `environments` (Postman Environments), or `mocks` (Postman Mock Servers).

filtersobjectoptionalStructured filter expression. Top-level key must be "$and" with an array of condition objects. Each condition: { "<field>": { "<operator>": <value> } }. Example: {"$and":[{"privateNetwork":{"$eq":true}}]}

limitintegeroptionalThe maximum number of search results to return. Maximum: 25.

ownershipstringoptionalThe ownership scope. Use `organization` to search all resources in your organization (default), `external` to search the public Postman network, or `all` to search across all scopes.

qstringoptionalThe search query (e.g. "payment API", "notification service", "Stripe").

postmanmcp_synccollectionwithspec#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.2 params▾

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.

NameTypeRequiredDescription

collectionUidstringrequiredThe collection's unique ID.

specIdstringrequiredThe spec's ID.

postmanmcp_syncspecwithcollection#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.2 params▾

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.

NameTypeRequiredDescription

collectionUidstringrequiredThe collection's unique ID.

specIdstringrequiredThe spec's ID.

postmanmcp_updatecollectionrequest#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.15 params▾

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.

NameTypeRequiredDescription

collectionIdstringrequiredThe collection's ID.

requestIdstringrequiredThe request's ID.

authstringoptionalThe request's authentication information.

datastringoptionalThe request body's form data.

dataModestringoptionalThe request body's data mode.

dataOptionsstringoptionalAdditional configurations and options set for the request body's various data modes.

descriptionstringoptionalThe request's description.

eventsstringoptionalA list of scripts configured to run when specific events occur.

graphqlModeDatastringoptionalThe request body's GraphQL mode data.

headerDataarrayoptionalThe request's headers.

methodstringoptionalThe request's HTTP method.

namestringoptionalThe request's name.

queryParamsarrayoptionalThe request's query parameters.

rawModeDatastringoptionalThe request body's raw mode data.

urlstringoptionalThe request's URL.

postmanmcp_updatemock#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.2 params▾

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.

NameTypeRequiredDescription

mockIdstringrequiredThe mock's ID.

mockobjectoptionalNo description.

postmanmcp_updatespecfile#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.5 params▾

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.

NameTypeRequiredDescription

filePathstringrequiredThe path to the file.

specIdstringrequiredThe spec's ID.

contentstringoptionalThe specification's stringified contents.

namestringoptionalThe file's name.

typestringoptionalThe type of file: - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file. - `DEFAULT` — A file referenced by the `ROOT` file.

postmanmcp_updatespecproperties#Updates an API specification's properties, such as its name.2 params▾

Updates an API specification's properties, such as its name.

NameTypeRequiredDescription

namestringrequiredThe spec's name.

specIdstringrequiredThe spec's ID.

postmanmcp_updateworkspace#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.2 params▾

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.

NameTypeRequiredDescription

workspaceIdstringrequiredThe workspace's ID.

workspaceobjectoptionalNo description.