Mattering Automations Postman integration
Connect Postman to Mattering Automations: workspaces, collections with forking and an asynchronous merge, environments, mock servers with publish controls and call logs, monitors with a run you can fire on demand, and the API Builder, all as workflow steps on one Postman API key.
The Mattering Automations Postman integration adds the Postman API to your automation canvas: list and manage workspaces, run full CRUD on collections including forking a collection and merging the fork back asynchronously, create and replace environments and their variables, build mock servers and read their call logs over a date window, create monitors and fire a run outside the schedule, and manage API definitions and versions in the API Builder.
The credential is a Postman API key, created in Postman under Settings, then Account settings, then API keys, and sent in the X-API-Key header on every request to api.postman.com. That header is the form to use: the current reference documents no query parameter alternative, and no OAuth flow for the REST API this integration calls. Postman does offer OAuth on its own MCP server, which is a separate surface from this API. A key carries exactly the permissions of the user who created it, so the account you connect with decides what these workflows can reach. Setup takes a few minutes, and this guide walks through each step and ends with the full node reference.
Two things shape how the nodes are used. First, identifiers: most Postman objects have both a bare id and a uid that combines the owner id with it, and the reference documents the unique id everywhere, so collections, environments, mock servers, and monitors are addressed by uid throughout while workspaces and API Builder APIs, which have no uid, use the id. Second, safety: of the 40 nodes, 16 read and 24 act, and seven are flagged destructive, the six deletes plus Postman: Merge Collection Fork. The API has no undelete, and the objects do not recover the same way underneath that: a deleted collection sits in the Postman app's trash for a period that depends on your plan, while a deleted workspace is not recoverable at all, which makes Postman: Delete Workspace the heaviest node here. So the read-first, gate-the-write pattern is the one this guide keeps returning to.
Before you start
- A Postman account that can create an API key under Settings, then Account settings, then API keys. The key inherits the permissions of the user who creates it, so connect with an account whose access matches what the workflows should be allowed to do, not simply the account nearest to hand.
- At least one workspace to point the first workflows at. Postman: Create Workspace can make one, so a fresh account is fine too, and the verify path below reads cleanly either way.
- A Mattering workspace with access to the Automations app.
- Not required and not stored here: a collection access key. Postman's per-collection access keys let an unauthenticated caller read one collection, which would mean a second secret pasted into node configuration in plain text; this integration authenticates every call with the one API key instead.
- A hosting note before you start: this integration sends every request to Postman's default API host, api.postman.com. Postman serves EU-hosted Enterprise teams from a separate host, and a key belonging to one of those teams will not authenticate against the default host. That gap is recorded rather than papered over.
Create your Postman API key
Mattering authenticates to Postman with an API key sent in the X-API-Key header. There is nothing to authorize and no scopes to pick: the key simply acts as the user who created it, with that user's team roles and workspace access. That makes setup short and makes the choice of account the real access-control decision.
Connect Postman to Mattering
Verify it works
After connecting, open any automation canvas and check the palette: a Postman section should list the query and action nodes. Drop Postman: Get Authenticated User onto the canvas and run a test step. It is the integration's natural probe, because it takes no parameters and every valid key can call it, and what comes back is useful in its own right: the username, email, and team the key belongs to, the roles assigned to it, and the account's operation usage counters for API calls, mock calls, and monitor request runs. Those counters are worth reading before any workflow that will make a lot of calls.
Next, run Postman: List Workspaces and copy a workspace id, because that is the value most other nodes start from. Then run Postman: List Collections and note the difference that matters: each row carries both an id and a uid, and it is the uid the collection, mock server, and monitor nodes ask for. Everything in this verify path is read-only, so it cannot reach any of the seven destructive nodes and it is safe to re-run whenever you rotate the key.
Node reference
40 nodes, generated from the connector itself so this reference always matches what ships.
Read and query nodes 16
Postman: Get API
postman_get_api
Fetch one API definition's metadata, and optionally the ids of the collections, schemas and versions linked to it. Note that this endpoint returns the API at the ROOT of the response (data.name, data.id), not wrapped in an api object. Git-connected APIs return only their versions and git repository information.
Postman: Get Authenticated User
postman_get_authenticated_user
Fetch the Postman user the API key belongs to: username, email, team, assigned roles, and the account's operation usage counters (API calls, mock calls, monitor request runs). Takes no parameters, so this is the credential health check to run first in any Postman automation, and the usage guard to run before a large batch.
Postman: Get Collection
postman_get_collection
Fetch a whole collection in Postman Collection Format v2.1.0: its info block, every folder and request, saved example responses, variables, auth and scripts. Set the model field to minimal when you only need the root-level request and folder ids rather than the full document.
Postman: Get Environment
postman_get_environment
Fetch one environment with all of its variables: each variable's key, value, type and whether it is enabled. Variables marked secret return their metadata rather than their value.
Postman: Get Merge Task Status
postman_get_merge_task_status
Check whether a collection merge or pull finished: returns successful, in-progress, or failed with the error message. Postman keeps a finished task's status for 24 hours and then returns 404, so poll shortly after the merge rather than the next day.
Postman: Get Mock Call Logs
postman_get_mock_call_logs
Read a mock server's call logs: who called which path with which method, which saved response was served, and the status code that came back. One call returns at most 100 logs or 6.5 MB, whichever comes first, so page with the cursor. Log retention depends on your Postman plan.
Postman: Get Mock Server
postman_get_mock
Fetch one mock server: its mock URL, the collection and environment behind it, whether it is public, whether it has deactivated, and its request-matching and simulated-delay settings.
Postman: Get Monitor
postman_get_monitor
Fetch one monitor with its schedule (cron and timezone), the regions it runs from, its notification and retry settings, and its last run: status, start and finish times, and the test and request pass and fail counts. This is how an automation checks whether the latest run passed.
Postman: Get Workspace
postman_get_workspace
Fetch one workspace with its full contents index: the collections, environments, mock servers, monitors and API specifications it holds, each with its id, name and unique id. The cheapest way to see everything inside a workspace in one call.
Postman: List API Versions
postman_list_api_versions
List an API's published versions with their ids, names, release notes and timestamps, newest first. Use it to find the version id a release automation should publish against, or to check what shipped last.
Postman: List APIs
postman_list_apis
List the APIs in a workspace with their ids, names, summaries and who last changed them. The workspace is required, which is why the other API nodes ask you to paste an API id rather than offering a picker.
Postman: List Collections
postman_list_collections
List collections you own or are subscribed to, optionally narrowed to one workspace. Each row carries the collection's id, uid, name, owner and, for forks, the fork label and parent. Postman recommends paging this endpoint; unpaginated calls are treated as deprecated. Passing an unknown workspace id returns 200 with an empty list rather than an error.
Postman: List Environments
postman_list_environments
List your environments, optionally narrowed to one workspace. Each row carries the environment's id, uid, name and owner. This is the lister behind the environment picker on the mock and monitor nodes.
Postman: List Mock Servers
postman_list_mocks
List active mock servers with their public mock URLs, the collection and environment each is built on, and their matching configuration. By default this returns mock servers you created across all workspaces. If both filters are filled, Postman honours the workspace one.
Postman: List Monitors
postman_list_monitors
List monitors with their ids, names, active flag and the collection and environment each runs. Filter by workspace, by the collection or environment they use, or to active monitors only. This is the lister behind the monitor picker on the other monitor nodes.
Postman: List Workspaces
postman_list_workspaces
List every workspace you can see: your own plus any shared with you. Each row carries the workspace id, name, type and visibility. This is the lister behind the workspace picker on every other Postman node, and the starting point for any automation that walks a team's collections.
Action nodes 24
Postman: Create API
postman_create_api
Create an API definition in a workspace. Returns the new API's id at the root of the response, ready to attach schemas, collections and versions to.
Postman: Create Collection
postman_create_collection
Create a collection in a workspace using the Postman Collection Format v2.1.0. Fill just the name for an empty collection, or pass a JSON array of items to create folders and requests in one call. Returns the new collection's id and uid.
Postman: Create Environment
postman_create_environment
Create an environment in a workspace with its starting set of variables. Useful for standing up a per-branch or per-tenant environment from an automation. The request body cannot exceed 30 MB.
Postman: Create Mock Server
postman_create_mock
Create a mock server from a collection's saved example responses and get back its mock URL, ready to point a frontend or a test suite at. Mock servers are public by default; set private to true to require a Postman API key. Collections that belong to an API definition cannot be mocked.
Postman: Create Monitor
postman_create_monitor
Create a monitor that runs a collection on a schedule and emails you when it fails. Give it a collection, a cron pattern and a timezone. Monitor runs draw down your account's monitor usage allowance, so pick a frequency you actually need. Collections that belong to an API definition cannot be monitored.
Postman: Create Workspace
postman_create_workspace
Create a workspace. Returns the new workspace's id, which every other Postman node can be pointed at. Postman returns 403 if your team's admins have restricted workspace creation or require approval for team workspaces, and public team workspace names must be unique.
Postman: Delete API
postman_delete_api
Permanently delete an API definition and its versions and schemas. DESTRUCTIVE: there is no undelete endpoint. Returns 204 No Content with an empty body on success.
Postman: Delete Collection
postman_delete_collection
Permanently delete a collection. DESTRUCTIVE: there is no undelete endpoint, and any mock server or monitor built on the collection deactivates. Fetch the collection with Postman: Get Collection first if you want a copy.
Postman: Delete Environment
postman_delete_environment
Permanently delete an environment. DESTRUCTIVE: there is no undelete endpoint, and any mock server or monitor linked to the environment deactivates.
Postman: Delete Mock Server
postman_delete_mock
Permanently delete a mock server. DESTRUCTIVE: there is no undelete endpoint, and the mock URL stops answering immediately, so anything pointed at it starts failing. The underlying collection is not affected.
Postman: Delete Monitor
postman_delete_monitor
Permanently delete a monitor and its run history. DESTRUCTIVE: there is no undelete endpoint. To stop a monitor temporarily, use Postman: Update Monitor with active set to false instead.
Postman: Delete Workspace
postman_delete_workspace
Permanently delete a workspace. DESTRUCTIVE: Postman has no undelete endpoint, and the workspace's collections, environments, mock servers and monitors go with it. Export anything worth keeping first.
Postman: Fork Collection
postman_create_collection_fork
Fork a collection into a workspace, so changes can be made and reviewed without touching the parent. Returns the fork's own id and uid plus the parent it came from. Deleting a fork never affects the parent, which is what makes this the safe way to let an automation edit someone else's collection.
Postman: Merge Collection Fork
postman_merge_collection_fork
Merge a forked collection into its parent, asynchronously. Returns a task id to poll with Postman: Get Merge Task Status. To PULL changes the other way, pass the fork as the destination and the parent as the source. DESTRUCTIVE: the merge rewrites the destination collection and there is no revert endpoint, and the deleteSource strategy additionally deletes the fork. Requires the Editor role on the collections involved.
Postman: Publish Mock Server
postman_publish_mock
Publish a mock server, which sets its access control to public so anyone with the mock URL can call it without a Postman API key. Reversible with Postman: Unpublish Mock Server.
Postman: Replace Collection
postman_replace_collection
Replace a collection's entire contents with the document you pass, in Postman Collection Format v2.1.0. Read the collection first, change what you need, and send the whole thing back. WARNING: items whose id values you omit are REMOVED and recreated with new ids, which breaks anything referencing the old ids. The body cannot exceed 100 MB. To change only a name, description, variables, auth or scripts, use Postman: Update Collection instead.
Postman: Replace Environment
postman_replace_environment
Replace an environment's contents. The values array you send REPLACES the whole variable list, so read the environment first and send back the full set with your change applied, or variables you leave out disappear. Only shared variable values (those synced to the Postman cloud) can be changed through the API.
Postman: Run Monitor
postman_run_monitor
Run a monitor now, outside its schedule, and return the run results: per-request status codes and response times, plus assertion and request totals and failures. This is a REAL run: every request in the monitored collection is sent to its live targets, and the run draws down your account's monitor usage allowance, so never point it at a collection that writes to production. Set run_async to true for long collections; a synchronous run over 300 seconds returns 202 and you read the outcome from Postman: Get Monitor.
Postman: Unpublish Mock Server
postman_unpublish_mock
Unpublish a mock server, which sets its access control back to private so calls must carry a Postman API key. The mock server itself is not deleted, and Postman: Publish Mock Server puts it back.
Postman: Update API
postman_update_api
Update an API definition's name, summary or description. The name is required by Postman on this endpoint even when you are only changing the description, so send the current name if you are not renaming it.
Postman: Update Collection
postman_update_collection
Update parts of a collection in place: its name and description (info), its variables, its default auth, or its scripts (events). Requests and folders are untouched, which makes this the safe way to rename a collection or rotate a variable. Postman rejects any property outside info, variable, auth and events.
Postman: Update Mock Server
postman_update_mock
Change a mock server's name, description, linked collection or environment, its private flag, or the single saved response every request should return. Only the fields you fill are sent.
Postman: Update Monitor
postman_update_monitor
Change a monitor's name, schedule, regions, notification list or run options, or pause it by setting active to false. Only the fields you fill are sent, so pausing a monitor needs nothing but the monitor and active.
Postman: Update Workspace
postman_update_workspace
Rename a workspace, rewrite its description, or change its visibility. Only the fields you fill are sent, so this never blanks a property you left empty. Some visibility changes are not permitted by the API (for example private to public), and publishing a public workspace is separately rate limited.
Using the integration
On the automation canvas
Postman nodes chain with every other node. A deploy webhook can call Postman: Create Mock Server for a preview branch and post the mock URL into a Mattering Comms channel, a nightly schedule can run Postman: Run Monitor and open a task in Mattering Productivity when assertions fail, and a weekly sweep can walk Postman: List Workspaces into Postman: Get Workspace and write the whole estate into a Mattering database. Pace that last one: Postman: List Workspaces, Postman: List Collections, and Postman: Get Workspace sit behind a limit of 10 calls in 10 seconds, much tighter than the API's 300 requests per minute, so put a short wait between workspaces instead of sizing the run against the per-minute figure. The two values almost everything downstream needs are the workspace id from Postman: List Workspaces and the collection uid from Postman: List Collections, so those two listers usually sit at the top of a Postman workflow.
From AI assistants over MCP
Every node speaks MCP, the open protocol for connecting AI assistants to tools, so Claude, ChatGPT, and any other MCP-capable assistant can drive the same surface, alongside Matter, the assistant built into the platform. The read nodes are the safest surface to hand an agent: Postman: List Workspaces, Postman: Get Workspace, Postman: List Collections, Postman: Get Collection, and Postman: Get Monitor let it answer questions about the API estate without changing anything. When an agent does need to write, forking is the pattern that makes it safe, and the seven destructive nodes belong behind conditions or approval steps. Postman also ships its own MCP server, remote over streamable HTTP at mcp.postman.com and mcp.eu.postman.com in full, minimal, and code variants, with OAuth on the remote US server, plus npm, Docker, and local STDIO options; for an assistant whose job is managing Postman, that is the one to connect, while these nodes are for when Postman is one step in a workflow spanning other tools and running on a schedule with no assistant in the loop.
The uid rule, and where it does not apply
Postman gives most objects two identifiers: a bare id, and a uid that combines the owner id with it. The reference types the collection, environment, mock, and monitor path parameters as the unique id, and every cross-object reference is a unique id too, including a monitor's collection and environment, a mock server's collection and environment, and a merge's source and destination. So every field in this integration asks for the uid and every picker returns one. Workspaces and API Builder APIs are the exception, because Postman gives those no uid at all. The field names carry the difference on the canvas: collection_uid, environment_uid, mock_uid, and monitor_uid against workspace_id and api_id.
Collections: replace against update
Two nodes write to a collection and they are not interchangeable. Postman: Update Collection changes a collection in place, its name and description, its variables, its default auth, or its scripts, and leaves every request and folder untouched, which makes it the safe way to rename a collection or rotate a variable. Postman: Replace Collection sends a whole Postman Collection Format v2.1.0 document and replaces the contents with it. Read the collection with Postman: Get Collection first, change what you need, and send the whole thing back, because items whose id values you omit are removed and recreated with new ids, which breaks anything referencing the old ones.
Fork, merge, and the task you have to poll
Postman: Fork Collection copies a collection into a workspace where an automation or an agent can change it without touching the parent, and deleting a fork never affects the parent, which is what makes it the safe way to edit a collection someone else owns. Merging back is asynchronous: Postman: Merge Collection Fork returns a task id rather than a finished merge, and Postman: Get Merge Task Status reports whether it finished, is still running, or failed with an error message. Poll shortly after Postman: Merge Collection Fork returns its task id, in the same run, with a short wait between attempts. Postman does not document how long a finished task's status stays readable, so a workflow should not come back for it the next morning; if the status no longer answers, read the destination collection with Postman: Get Collection and check whether the merged content is present. To pull changes the other way, pass the fork as the destination and the parent as the source.
Mock servers and their call logs
Postman: Create Mock Server builds a mock from a collection's saved example responses and returns the mock URL, and mocks are public by default unless you set private to true, which requires a Postman API key on every call. Postman: Publish Mock Server and Postman: Unpublish Mock Server flip that access control after the fact, so a mock can be opened up for a demo and closed again by a workflow. Postman: Get Mock Call Logs reads who called which path with which method, which saved response was served, and the status that came back, over a since and until window; one call returns at most 100 logs or 6.5 MB, whichever comes first, so page with the cursor. How long logs are retained depends on your Postman plan. Collections that belong to an API definition cannot be mocked.
Monitors, including the run that is a real run
Postman: Create Monitor takes a collection, a cron pattern, and a timezone, and Postman: Get Monitor reads the schedule, the regions, and the last run with its test and request pass and fail counts, which is how a workflow checks whether the latest run passed. Postman: Run Monitor fires a run outside the schedule, and it is a real run: every request in the monitored collection is sent to its live targets, and the run draws down the account's monitor usage allowance. Never point it at a collection that writes to production. Set run_async to true for long collections, because a synchronous run over 300 seconds returns 202 and the outcome is then read from Postman: Get Monitor. To pause a monitor rather than delete it, use Postman: Update Monitor with active set to false.
The seven destructive nodes, gated
Postman: Delete Workspace is the heaviest: it takes the workspace's collections, environments, mock servers, and monitors with it, and a deleted workspace is not recoverable at all. The API has no undelete for anything, but the objects differ underneath that. A collection removed with Postman: Delete Collection goes to the trash in the Postman app and can be restored there for a period that depends on your plan, which a workspace cannot. Postman's own guidance is to review a collection's monitors and mock servers before deleting it, and Postman surfaces a deactivated flag on mock servers and monitors, so a workflow can read that state rather than assume it. Postman: Delete Mock Server removes the mock, so anything pointed at its URL needs repointing. Postman: Delete Environment and Postman: Delete Monitor remove the environment and the monitor themselves, and Postman: Delete API returns 204 No Content on success. The seventh deletes nothing by default: Postman: Merge Collection Fork permanently applies one collection's contents onto another with no revert endpoint, and its deleteSource strategy also deletes the fork. Read or export first, then gate all seven behind a condition, an approval task, or a manual run.
What stays off the canvas
Postman's documented API is much larger than these 40 nodes, and the exclusions are choices rather than gaps in coverage. Collection items, meaning folder, request, and saved-response CRUD, are a family of their own and deserve one coherent pass rather than an orphan node, and the same reasoning keeps out API Builder schemas and schema files, where the schema id has no lister that returns a human-readable label. Comments, pull requests, roles, tags, Spec Hub specifications, teams, users and groups, SCIM, audit logs, billing, analytics, the API Catalog, the Private API Network, the secret scanner, service accounts, and OAuth token management are out for now. Two more are deliberate: collection access keys, because they would mean a second plain-text secret in node configuration, and Postman's older synchronous fork merge, which the reference marks deprecated in favour of the asynchronous merge that ships here.
Troubleshooting
Test Connection fails with a 401 error
Nodes that ran yesterday now all return 401
A node returns 404 for an object that exists in Postman
Get Merge Task Status no longer answers for a merge the workflow ran earlier
Requests start failing with 429
List Collections with a workspace id returns an empty list instead of an error
A collection update removed requests and gave them new ids
A node succeeded but returned an empty object
Create Workspace returns 403
Related
The Postman MCP
What connecting Postman unlocks for AI agents and automations, with common uses and FAQs.
More guides
All Automations documentation
Every integration guide, plus how connectors, credentials, and workflows fit together.
Postman is a trademark of its respective owner. Mattering uses platform names to identify the services these integrations connect to; no endorsement or affiliation is implied.