Postman

Postman Workspaces API

Manage personal, team, partner, public, and private workspaces. Control visibility, membership, roles, and the elements (collections, environments, mocks, monitors, APIs) attached to each workspace.

GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /invitations Invite or remove Partner Workspace partners · Manage Partner Workspace invites #
Ask an LLM
“How do I invite external partners by email to a Partner Workspace?”
“Can I remove a partner from all of a partnership's workspaces at once?”
Tell an agent
Send Partner Workspace invitations to these partner emails.
Remove this partner from the partnership and all its workspaces.
GET /workspaces List workspaces · Get all workspaces #
Ask an LLM
“Which workspaces do I have access to?”
“Can I filter workspaces by type or by who created them?”
Tell an agent
List all my workspaces.
List {type} workspaces created by user {createdBy}.
POST /workspaces Create a workspace · Create a workspace #
Ask an LLM
“How do I create a new team workspace?”
“Why would creating a workspace return a Forbidden error?”
Tell an agent
Create a workspace {workspace}.
Set up a new personal workspace for my project.
GET /workspaces-roles List the available workspace roles · Get all roles #
Ask an LLM
“What roles can be assigned in a workspace on my plan?”
“Which workspace role IDs exist so I can assign them?”
Tell an agent
List every workspace role my team's plan offers.
Show the available workspace role definitions.
GET /workspaces/{workspaceId} Get a workspace · Get a workspace #
Ask an LLM
“How do I look up one workspace's details and visibility?”
“Can I see what collections and environments are inside a workspace?”
Tell an agent
Get workspace {workspaceId}.
Show the details and visibility of workspace {workspaceId}.
PUT /workspaces/{workspaceId} Rename a workspace or change its visibility · Update a workspace #
Ask an LLM
“Can I rename a workspace or make it public?”
“Which workspace visibility changes are not allowed on Free and Solo plans?”
Tell an agent
Update workspace {workspaceId} with {workspace}.
Rename workspace {workspaceId}.
DELETE /workspaces/{workspaceId} Delete a workspace · Delete a workspace #
Ask an LLM
“How do I delete a workspace I no longer use?”
“Can I remove a whole workspace through the API?”
Tell an agent destructive · confirm first
Delete workspace {workspaceId}.
Permanently remove the workspace {workspaceId}.
GET /workspaces/{workspaceId}/activities View a workspace's activity feed · Get a workspace's activity feed #
Ask an LLM
“What has changed recently in this workspace and who did it?”
“Can I filter a workspace's activity to one user or element type?”
Tell an agent
Show the activity feed for workspace {workspaceId}.
Show what user {userId} did in workspace {workspaceId}.
POST /workspaces/{workspaceId}/element-transfers Move an element to another workspace · Transfer element to a workspace #
Ask an LLM
“How do I move a collection or environment from one workspace to another?”
“Which kinds of elements can be transferred between workspaces?”
Tell an agent
Move {type} {id} from workspace {workspaceId} to {to}.
Transfer element {id} of type {type} out of workspace {workspaceId} into {to}.
GET /workspaces/{workspaceId}/global-variables Get a workspace's global variables · Get global variables #
Ask an LLM
“What global variables are defined in this workspace?”
“Can I read the globals shared across a workspace's collections and scripts?”
Tell an agent
Get the global variables of workspace {workspaceId}.
Show the globals defined in workspace {workspaceId}.
PUT /workspaces/{workspaceId}/global-variables Replace a workspace's global variables · Update global variables #
Ask an LLM
“Does updating global variables replace all existing ones in the workspace?”
“How do I set new global variable values for a workspace?”
Tell an agent
Replace the global variables of workspace {workspaceId} with {values}.
Overwrite workspace {workspaceId} globals so they match {values}.
GET /workspaces/{workspaceId}/roles See who has which role in a workspace · Get a workspace's roles #
Ask an LLM
“Who are the members of this workspace and what roles do they have?”
“Can I see user group and partner roles on a workspace?”
Tell an agent
List the roles in workspace {workspaceId}.
Show which users, groups and partners have access to workspace {workspaceId}.
PATCH /workspaces/{workspaceId}/roles Change members' roles in a workspace · Update workspace roles #
Ask an LLM
“How do I make someone an admin of a workspace?”
“Can I update workspace roles using SCIM IDs instead of Postman user IDs?”
Tell an agent
Update the roles in workspace {workspaceId} with {roles}.
Assign workspace {workspaceId} roles {roles} using {identifierType} IDs.
PATCH /workspaces/{workspaceId}/transfers Move a workspace to another team · Transfer workspace to a team #
Ask an LLM
“Can I transfer a workspace from one team to another in my organization?”
“Which plan is required to move workspaces between teams?”
Tell an agent
Transfer workspace {workspaceId} from team {source} to team {destination}.
Move workspace {workspaceId} over to team {destination} from {source}.
GET /workspaces/{workspaceId}/updates List a workspace's updates · Get all workspace updates #
Ask an LLM
“What announcements have been posted as updates in this workspace?”
“Can I filter workspace updates by category?”
Tell an agent
List the updates posted in workspace {workspaceId}.
Show {category} updates in workspace {workspaceId}.
POST /workspaces/{workspaceId}/updates Post an update to a workspace · Create a workspace update #
Ask an LLM
“How do I post an announcement to keep workspace members informed?”
“Can a workspace update link to related collections or APIs?”
Tell an agent
Post a {category} update on {topic} to workspace {workspaceId}: {description}.
Announce {description} in workspace {workspaceId} under topic {topic}, category {category}.
GET /workspaces/{workspaceId}/updates/{updateId} Get one workspace update · Get a workspace update #
Ask an LLM
“How do I read a single workspace update by its ID?”
“Can I see the full text of one announcement in a workspace?”
Tell an agent
Get update {updateId} in workspace {workspaceId}.
Show the workspace update {updateId} from {workspaceId}.
DELETE /workspaces/{workspaceId}/updates/{updateId} Delete a workspace update · Delete a workspace update #
Ask an LLM
“How do I remove an announcement posted in a workspace?”
“Can I delete an outdated workspace update?”
Tell an agent destructive · confirm first
Delete update {updateId} from workspace {workspaceId}.
Remove the workspace update {updateId} in {workspaceId}.
PATCH /workspaces/{workspaceId}/updates/{updateId} Edit or pin a workspace update · Update a workspace update #
Ask an LLM
“Can I pin a workspace update so it stays at the top?”
“How do I edit the text of an update I already posted in a workspace?”
Tell an agent
Edit update {updateId} in workspace {workspaceId}: topic {topic}, category {category}, text {description}.
Pin update {updateId} in workspace {workspaceId} ({isPinned}) keeping topic {topic}, category {category}, text {description}.

Documentation

📖
Documentation
https://www.postman.com/postman/postman-public-workspace/documentation/i2uqzpp/postman-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-workspaces-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-workspace-update-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-workspace-update-post-patch-response-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-update-workspace-update-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-create-workspace-update-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-transfer-workspace-element-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/json-schema/postman-get-workspaces-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/postman:workspaces-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

postman-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Postman Workspaces API
  version: 1.0.0
servers:
- url: https://api.postman.com
  description: https://api.postman.com
- url: https://api.eu.postman.com
  description: https://api.eu.postman.com
tags:


# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/postman/refs/heads/main/openapi/postman-workspaces-api-openapi.yml