The Postman MCP connector routes your AI agent's tool calls to Postman's own MCP server through Scalekit. Each user signs in to Postman once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 41 tools.
- Tools
- 41
- What they doRead · write · destructive
- 20 · 21 · 020 read21 write0 destructive
- Users sign in with
- OAuth
- OAuth app
- Scalekit's or your own
What you can do
- Manage collections: create, get, replace, and duplicate collections, and add or update their requests and responses
- Work with API specs: create and edit specifications and their files, and generate collections from specs or specs from collections
- Manage environments: create, list, fetch, and replace environments and their variables
- Run mock servers: create, update, publish, and list mock servers for collections
- Organize workspaces: create, list, and update workspaces and search for requests, collections, and specs
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Postman MCP connection
In AgentKit > Connections, create a Postman MCP connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Scalekit credentials are available for Postman MCP server, so you don't need to register an OAuth app.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'postmanmcp'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Postman MCP:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'postmanmcp_getauthenticateduser',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "postmanmcp"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="postmanmcp_getauthenticateduser",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpostmanmcp_getallspecsGets all API specifications in a workspace.Read-onlyGet All Specs
Gets all API specifications in a workspace.
Inputs
workspaceIdstringrequired- The workspace's ID.
cursorstring- The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
limitinteger- The maximum number of rows to return in the response.default
10
postmanmcp_getauthenticateduserGets information about the authenticated user.Read-onlyGet Authenticated User
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.
Inputs
This tool takes no inputs.
postmanmcp_getcollectionGet information about a collection.Read-onlyGet Collection
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.
Inputs
collectionIdstringrequired- The collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).
access_keystring- A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.
modelstring- Optional 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.one of
minimalfull
postmanmcp_getcollectionsThe workspace ID query is required for this endpoint.Read-onlyGet Collections
The workspace ID query is required for this endpoint. If not provided, the LLM should ask the user to provide it.
Inputs
workspacestringrequired- The workspace's ID.
limitinteger- The maximum number of rows to return in the response.
namestring- Filter results by collections whose name exactly matches the given value. Partial or substring matches are not supported.
offsetinteger- The zero-based offset of the first item to return.
postmanmcp_getduplicatecollectiontaskstatusGets the status of a collection duplication task.Read-onlyGet Duplicate Collection Task Status
Gets the status of a collection duplication task.
Inputs
taskIdstringrequired- The task's unique ID.
postmanmcp_getenabledtoolsIMPORTANT: Run this tool first when a requested tool is unavailable.Read-onlyGet Enabled Tools
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.
Inputs
This tool takes no inputs.
postmanmcp_getenvironmentGets information about an environment.Read-onlyGet Environment
Gets information about an environment.
Inputs
environmentIdstringrequired- The environment's ID.
postmanmcp_getenvironmentsGets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).Read-onlyGet Environments
Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
Inputs
workspacestring- The workspace's ID.
postmanmcp_getgeneratedcollectionspecsGets the API specification generated for the given collection.Read-onlyGet Generated Collection Specs
Gets the API specification generated for the given collection.
Inputs
collectionUidstringrequired- The collection's unique ID.
elementTypestringrequired- The `spec` value.
postmanmcp_getmockGets information about a mock server.Read-onlyGet Mock
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.
Inputs
mockIdstringrequired- The mock's ID.
postmanmcp_getmocksGets all active mock servers.Read-onlyGet Mocks
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.
Inputs
teamIdstring- Return only results that belong to the given team ID. - For team-scoped requests, set this from GET `/me` (`me.teamId`).
workspacestring- Return only results found in the given workspace ID. - Prefer this parameter when the user mentions a specific workspace.
postmanmcp_getspecGets information about an API specification.Read-onlyGet Spec
Gets information about an API specification.
Inputs
specIdstringrequired- The spec's ID.
postmanmcp_getspeccollectionsGets all of an API specification's generated collections.Read-onlyGet Spec Collections
Gets all of an API specification's generated collections.
Inputs
elementTypestringrequired- The `collection` element type.
specIdstringrequired- The spec's ID.
cursorstring- The pointer to the first record of the set of paginated results. To view the next response, use the `nextCursor` value for this parameter.
limitinteger- The maximum number of rows to return in the response.default
10
postmanmcp_getspecdefinitionGets the complete contents of an OpenAPI or AsyncAPI specification's definition.Read-onlyGet Spec Definition
Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.
Inputs
specIdstringrequired- The spec's ID.
postmanmcp_getspecfileGets the contents of an API specification's file.Read-onlyGet Spec File
Gets the contents of an API specification's file.
Inputs
filePathstringrequired- The path to the file.
specIdstringrequired- The spec's ID.
postmanmcp_getspecfilesGets all the files in an API specification.Read-onlyGet Spec Files
Gets all the files in an API specification.
Inputs
specIdstringrequired- The spec's ID.
postmanmcp_gettaggedentities**Requires an Enterprise plan.** Tagging is only available on Postman Enterprise plans.Read-onlyGet Tagged Entities
**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.
Inputs
slugstringrequired- The tag's ID within a team or individual (non-team) user scope.
cursorstring- The 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.
directionstring- The ascending (`asc`) or descending (`desc`) order to sort the results by, based on the time of the entity's tagging.one of
ascdescdefaultdesc entityTypestring- Filter results for the given entity type.one of
apicollectionworkspace limitinteger- The maximum number of tagged elements to return in a single call.default
10
postmanmcp_getworkspaceGets information about a workspace.Read-onlyGet Workspace
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)).
Inputs
workspaceIdstringrequired- The workspace's ID.
includestring- Include 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.
one of
mocks:deactivatedscim
postmanmcp_getworkspacesGets all workspaces you have access to.Read-onlyGet Workspaces
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\`
Inputs
createdByinteger- Return 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`.
cursorstring- The cursor to get the next set of results in a paginated response. Get this value from the `meta.nextCursor` field in the previous response.
elementIdstring- Filter 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.
elementTypestring- Filter 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.one of
collectionspecification includestring- Include 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.
one of
mocks:deactivatedscim limitinteger- The maximum number of workspaces to return per page. Defaults to 100.
default
100 typestring- The 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.
one of
personalteamprivatepublicpartner
postmanmcp_searchpostmanelementsSearch for Postman entities (requests, collections, workspaces, specs, flows, environments, and mocks).Read-onlySearch Postman Elements
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"}}]}`
Inputs
cursorstring- The cursor to get the next set of results in the paginated response. Pass the `nextCursor` value from the previous response.
entityTypestring- The 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).one of
requestscollectionsworkspacesspecsflowsenvironmentsmocksdefaultrequests filtersobject- Structured filter expression. Top-level key must be "$and" with an array of condition objects. Each condition: { "<field>": { "<operator>": <value> } }. Example: {"$and":[{"privateNetwork":{"$eq":true}}]}
limitinteger- The maximum number of search results to return. Maximum: 25.default
10 ownershipstring- The 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.one of
organizationexternalalldefaultorganization qstring- The search query (e.g. "payment API", "notification service", "Stripe").
postmanmcp_createcollectionCreates 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).WriteCreate Collection
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.
Inputs
workspacestringrequired- The workspace's ID.
collectionobject- No description.
postmanmcp_createcollectionrequestCreates a request in a collection.WriteCreate Collection Request
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.
Inputs
collectionIdstringrequired- The collection's ID.
authstring- The request's authentication information.
datastring- The request body's form data.
dataModestring- The request body's data mode.one of
rawurlencodedformdatabinarygraphql dataOptionsstring- Additional configurations and options set for the request body's various data modes.
descriptionstring- The request's description.
eventsstring- A list of scripts configured to run when specific events occur.
folderIdstring- The folder ID in which to create the request. By default, the system will create the request at the collection level.
graphqlModeDatastring- The request body's GraphQL mode data.
headerDataarray- The request's headers.
methodstring- The request's HTTP method.one of
GETPUTPOSTPATCHDELETECOPYHEADOPTIONSLINKUNLINKPURGELOCKUNLOCKPROPFINDVIEW namestring- The 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.
queryParamsarray- The request's query parameters.
rawModeDatastring- The request body's raw mode data.
urlstring- The request's URL.
postmanmcp_createcollectionresponseCreates a request response in a collection.WriteCreate Collection Response
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.
Inputs
collectionIdstringrequired- The collection's ID.
requeststringrequired- The parent request's ID.
cookiesstring- The response's cookie data.
dataModestring- The associated request body's data mode.one of
rawurlencodedformdatabinarygraphql dataOptionsstring- Additional configurations and options set for the request body's various data modes.
descriptionstring- The response's description.
headersarray- A list of headers.
languagestring- The response body's language type.
methodstring- The request's HTTP method.one of
GETPUTPOSTPATCHDELETECOPYHEADOPTIONSLINKUNLINKPURGELOCKUNLOCKPROPFINDVIEW mimestring- The response's MIME type.
namestring- The 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.
rawDataTypestring- The response's raw data type.
rawModeDatastring- The associated request body's raw mode data.
requestObjectstring- A JSON-stringified representation of the associated request.
responseCodeobject- The response's HTTP response code information.
statusstring- The response's HTTP status text.
textstring- The raw text of the response body.
timestring- The time taken by the request to complete, in milliseconds.
urlstring- The associated request's URL.
postmanmcp_createenvironmentCreates an environment.WriteCreate Environment
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.
Inputs
workspacestringrequired- The workspace's ID.
environmentobject- Information about the environment.
postmanmcp_createmockCreates a mock server in a collection.WriteCreate Mock
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.
Inputs
workspacestringrequired- The workspace's ID.
mockobject- No description.
postmanmcp_createspecCreates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/).WriteCreate Spec
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.
Inputs
filesarrayrequired- A list of the specification's files and their contents.
namestringrequired- The specification's name.
typestringrequired- The type of API specification.one of
OPENAPI:2.0OPENAPI:3.0OPENAPI:3.1ASYNCAPI:2.0ASYNCAPI:3.0PROTOBUF:2PROTOBUF:3GRAPHQLSMITHY:2.0 workspaceIdstringrequired- The workspace's ID.
postmanmcp_createspecfileCreates a file for an OpenAPI or a protobuf 2 or 3 specification.WriteCreate Spec File
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.
Inputs
contentstringrequired- The file's stringified contents.
pathstringrequired- The file's path. Accepts JSON or YAML files.
specIdstringrequired- The spec's ID.
postmanmcp_createworkspaceCreates a new [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).WriteCreate Workspace
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.
Inputs
workspaceobject- Information about the workspace.
postmanmcp_duplicatecollectionCreates a duplicate of the given collection in another workspace.WriteDuplicate Collection
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.
Inputs
collectionIdstringrequired- The collection's unique ID.
workspacestringrequired- The workspace ID in which to duplicate the collection.
suffixstring- An optional suffix to append to the duplicated collection's name.
postmanmcp_generatecollectionCreates a collection from the given API specification.WriteGenerate Collection
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.
Inputs
elementTypestringrequired- The `collection` element type.
namestringrequired- The generated collection's name.
optionsobjectrequired- The 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.
specIdstringrequired- The spec's ID.
postmanmcp_generatespecfromcollectionGenerates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection.WriteGenerate Spec From Collection
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.
Inputs
collectionUidstringrequired- The collection's unique ID.
elementTypestringrequired- The `spec` value.
formatstringrequired- The format of the API specification.one of
JSONYAML namestringrequired- The API specification's name.
typestringrequired- The specification's type.one of
OPENAPI:2.0OPENAPI:3.0OPENAPI:3.1
postmanmcp_publishmockPublishes a mock server.WritePublish Mock
Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.
Inputs
mockIdstringrequired- The mock's ID.
postmanmcp_putcollectionReplaces 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).WritePut Collection
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.
- Idempotent
Inputs
collectionIdstringrequired- The collection ID must be in the form <OWNER_ID>-<UUID> (e.g. 12345-33823532ab9e41c9b6fd12d0fd459b8b).
collectionobject- No description.
Preferstring- The `respond-async` header to perform the update asynchronously.
postmanmcp_putenvironmentReplaces all the contents of an environment with the given information.WritePut Environment
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.
- Idempotent
Inputs
environmentIdstringrequired- The environment's ID.
environmentobject- Information about the environment.
postmanmcp_synccollectionwithspecSyncs a collection generated from an API specification.WriteSync Collection With Spec
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.
- Idempotent
Inputs
collectionUidstringrequired- The collection's unique ID.
specIdstringrequired- The spec's ID.
postmanmcp_syncspecwithcollectionSyncs an API specification linked to a collection.WriteSync Spec With Collection
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.
- Idempotent
Inputs
collectionUidstringrequired- The collection's unique ID.
specIdstringrequired- The spec's ID.
postmanmcp_updatecollectionrequestUpdates a request in a collection.WriteUpdate Collection Request
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.
- Idempotent
Inputs
collectionIdstringrequired- The collection's ID.
requestIdstringrequired- The request's ID.
authstring- The request's authentication information.
datastring- The request body's form data.
dataModestring- The request body's data mode.one of
rawurlencodedformdatabinarygraphql dataOptionsstring- Additional configurations and options set for the request body's various data modes.
descriptionstring- The request's description.
eventsstring- A list of scripts configured to run when specific events occur.
graphqlModeDatastring- The request body's GraphQL mode data.
headerDataarray- The request's headers.
methodstring- The request's HTTP method.one of
GETPUTPOSTPATCHDELETECOPYHEADOPTIONSLINKUNLINKPURGELOCKUNLOCKPROPFINDVIEW namestring- The request's name.
queryParamsarray- The request's query parameters.
rawModeDatastring- The request body's raw mode data.
urlstring- The request's URL.
postmanmcp_updatemockUpdates a mock server.WriteUpdate Mock
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.
- Idempotent
Inputs
mockIdstringrequired- The mock's ID.
mockobject- No description.
postmanmcp_updatespecfileUpdates a file for an OpenAPI or protobuf 2 or 3 specification.WriteUpdate Spec File
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.
- Idempotent
Inputs
filePathstringrequired- The path to the file.
specIdstringrequired- The spec's ID.
contentstring- The specification's stringified contents.
namestring- The file's name.
typestring- The 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.
one of
DEFAULTROOT
postmanmcp_updatespecpropertiesUpdates an API specification's properties, such as its name.WriteUpdate Spec Properties
Updates an API specification's properties, such as its name.
- Idempotent
Inputs
namestringrequired- The spec's name.
specIdstringrequired- The spec's ID.
postmanmcp_updateworkspaceUpdates a workspace's property, such as its name or visibility.WriteUpdate Workspace
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.
- Idempotent
Inputs
workspaceIdstringrequired- The workspace's ID.
workspaceobject- No description.
No tools match.