How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.

Documentation Provider Profile APIs.io OpenAPI GitHub

Postman Workspaces API is one of 39 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API Management, Collaboration, and Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 11 paths, and defines 153 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.

19 operations 11 paths 153 schemas 2 DELETE8 GET3 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.getpostman.com
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Postman Workspaces API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (PostmanApiKey). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (scimApiKey).

  • scimApiKey — A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/generating-scim-api-key) for calls to SCIM…

Paths & Operations 19

Across 11 paths, the API surfaces 19 operations — 2 DELETE, 8 GET, 3 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

workspaces 19
POST
/invitations
Manage Partner Workspace invites
managePartnerWorkspaceInvites 1 param body → 200400401403404500
GET
/workspaces
Get all workspaces
getWorkspaces 8 params → 200400401500
POST
/workspaces
Create a workspace
createWorkspace 1 param body → 200400401403500
GET
/workspaces-roles
Get all roles
getAllWorkspaceRoles 1 param → 200401403500
GET
/workspaces/{workspaceId}
Get a workspace
getWorkspace 3 params → 200401404500
PUT
/workspaces/{workspaceId}
Update a workspace
updateWorkspace 2 params body → 200400403404500
DELETE
/workspaces/{workspaceId}
Delete a workspace
deleteWorkspace 2 params → 200400401500
GET
/workspaces/{workspaceId}/activities
Get a workspace's activity feed
getWorkspaceActivityFeed 6 params → 200400401403404500
POST
/workspaces/{workspaceId}/element-transfers
Transfer element to a workspace
transferWorkspaceElement 2 params body → 200400403404500
GET
/workspaces/{workspaceId}/global-variables
Get global variables
getWorkspaceGlobalVariables 2 params → 200500
PUT
/workspaces/{workspaceId}/global-variables
Update global variables
updateWorkspaceGlobalVariables 2 params body → 200500
GET
/workspaces/{workspaceId}/roles
Get a workspace's roles
getWorkspaceRoles 3 params → 200401403404500
PATCH
/workspaces/{workspaceId}/roles
Update workspace roles
updateWorkspaceRoles 3 params body → 200400401403404422500
PATCH
/workspaces/{workspaceId}/transfers
Transfer workspace to a team
transferWorkspaceToTeam 2 params body → 200400401403404500
GET
/workspaces/{workspaceId}/updates
Get all workspace updates
getWorkspaceUpdates 4 params → 200400401403404500
POST
/workspaces/{workspaceId}/updates
Create a workspace update
createWorkspaceUpdate 2 params body → 200400401403404422500
GET
/workspaces/{workspaceId}/updates/{updateId}
Get a workspace update
getWorkspaceUpdate 3 params → 200401403404500
DELETE
/workspaces/{workspaceId}/updates/{updateId}
Delete a workspace update
deleteWorkspaceUpdate 3 params → 204401403404500
PATCH
/workspaces/{workspaceId}/updates/{updateId}
Update a workspace update
patchWorkspaceUpdate 3 params body → 200400401403404422500

Schemas 153

The contract defines 153 schemas that model the data the API accepts and returns. The most detailed are GetWorkspaceWorkspace (16 properties), workspaceUpdatePostPatchResponseData (11 properties), workspaceUpdateData (11 properties), GetWorkspaceActivityFeedDataItems (10 properties). Each schema is shown below with its type and property counts.

Workspaces_managePartnerWorkspaceInvites_Request
GetWorkspaceUpdateRequestInternalServerError
getWorkspaceGlobalVariables
object
Information about the workspace's global variables.
1 property
workspaceUpdateRelatedResourcesData
array
A list containing the update's related elements. Related elements include links to collections, requests, folders, and saved examples in the update.
CommonErrorTypeTitleDetailStatusType
managePartnerWorkspaceInvitesRemovePartnerResponse
object
4 properties
GetWorkspaceWorkspaceVisibility
string
The workspace's visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/changing-workspace-vis…
ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItems
object
4 properties
GetWorkspaceRolesRequestForbiddenError
limitDefault15
integer
UpdateWorkspaceRolesRequestInternalServerError
commonErrorTypeTitleDetail
object
3 properties
GetAllWorkspaceRolesRoles
object
Information about the workspace's roles.
3 properties
getWorkspaceActivityFeed
object
2 properties
GetAllWorkspaceRolesRequestForbiddenError
UpdateWorkspaceWorkspace
object
4 properties
managePartnerWorkspaceInvitesInvitePartnerResponse
object
6 properties
workspaceUpdatePostPatchResponseData
object
11 properties
ManagePartnerWorkspaceInvitesRemovePartnerTargetEntity
string
The workspace value.
transferWorkspaceToTeamResponse
object
1 property
managePartnerWorkspaceInvitesTargetObjectUserId
GetWorkspaceWorkspaceSpecsItems
object
Information about the API specification.
3 properties
managePartnerWorkspaceInvitesRemovePartner
object
The request body for removing partners from a Partner Workspace.
4 properties 4 required
GetWorkspaceRolesRequestUnauthorizedError
GetWorkspaceWorkspaceScim
object
An object containing SCIM user IDs. This object only returns if you pass the include=scim query parameter.
2 properties
userId-2
integer
ManagePartnerWorkspaceInvitesTargetObjectUserId0
object
The target on which to perform the action.
1 property 1 required
updateWorkspaceGlobalVariablesResponse
object
Information about the workspace's updated global variables.
1 property
ManagePartnerWorkspaceInvitesTargetObjectUserId1
object
The target on which to perform the action.
1 property 1 required
createWorkspaceUpdate
object
4 properties 3 required
updateWorkspaceResponse
object
1 property
ManagePartnerWorkspaceInvitesRemovePartnerTeamAction
string
The removepartner action.
workspaceIncludeQuery
string
Workspaces_managePartnerWorkspaceInvites_Response_200
CreateWorkspaceRequestUnauthorizedError
getWorkspaceUpdates
object
2 properties
globalVariable
object
Information about the global variable.
5 properties
getWorkspaceRoles
object
Information about the workspace's roles.
1 property
GetWorkspaceRequestUnauthorizedError
CreateWorkspaceWorkspaceType
string
The type of workspace: - personal - private — Private workspaces are available on Postman [Team and Enterprise plans](https://www.postman.com/pricing). - publi…
GetWorkspaceWorkspaceEnvironmentsItems
object
Information about the environment.
3 properties
updateWorkspaceRoles
object
1 property
GetWorkspaceWorkspaceMonitorsItems
object
Information about the monitor.
4 properties
transferWorkspaceElementResponse
object
1 property
CreateWorkspaceWorkspace
object
Information about the workspace.
5 properties 2 required
getWorkspacesWorkspaceData
object
Information about the workspace.
9 properties
UpdateWorkspaceRolesRolesItems
object
3 properties 3 required
CommonErrorNameMessageError
object
Information about the error.
2 properties
workspaceUpdateId
integer
UpdateWorkspaceRolesRequestForbiddenError
transferWorkspaceElement
object
3 properties 3 required
TransferWorkspaceElementId
The workspace element's ID.
ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItems
object
5 properties
workspaceCreatedBy
integer
GetWorkspacesMeta
object
The response's meta information for paginated results. This object only returns if you pass the limit query parameter.
1 property
GetWorkspacesRequestUnauthorizedError
identifierType
string
partnerEmailAddress
string
A partner's email address.
commonErrorNameMessageOnly
object
2 properties
limitMax100
integer
GetAllWorkspaceRolesRequestUnauthorizedError
meta
object
1 property
PatchWorkspaceUpdateRequestInternalServerError
GetWorkspaceWorkspaceCollectionsItems
object
Information about the collection.
3 properties
GetWorkspacesRequestBadRequestError
managePartnerWorkspaceInvitesRemovePartnerTeam
object
The request body for removing partners from partnership with a team.
4 properties 4 required
workspaceUpdateCreatedByData
object
Information about the user that created the workspace update.
3 properties
GetWorkspacesWorkspaceDataType
string
The type of workspace.
deleteWorkspace
object
1 property
TransferWorkspaceElementType
string
The type of element to transfer.
UpdateWorkspaceResponseWorkspace
object
Information about the updated workspace.
2 properties
GetWorkspacesRequestInternalServerError
commonErrorTypeTitleDetailStatusInstance
object
5 properties
workspaceUpdateData
object
Information about the workspace update.
11 properties
getWorkspacesScimObject
object
An object containing SCIM user IDs. This object only returns if you pass the include=scim query parameter.
1 property
commonErrorNameMessage
object
1 property
getWorkspace
object
1 property
GetWorkspaceWorkspaceType
string
The type of workspace.
transferWorkspaceToTeam
object
2 properties 2 required
elementType-3
string
updateWorkspaceUpdate
object
5 properties 3 required
workspaceElementTypeQuery
string
getAllWorkspaceRoles
object
1 property
GlobalVariableType
string
The [type](https://learning.postman.com/docs/sending-requests/variables/variable-types) of variable.
workspaceElementIdQuery
string
managePartnerWorkspaceInvitesTargetObjectEmails
object
The target on which to perform the action.
1 property 1 required
DeleteWorkspaceRequestUnauthorizedError
TransferWorkspaceToTeamResponseWorkspace
object
1 property
CreateWorkspaceRequestInternalServerError
Workspace400ErrorError
object
2 properties
UpdateWorkspaceWorkspaceType
string
The new workspace visibility [type](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/changing-workspace-visibili…
workspaceUpdateCategoryData
string
The update's assigned category.
CreateWorkspaceResponseWorkspace
object
Information about the created workspace.
2 properties
DeleteWorkspaceWorkspace
object
Information about the deleted workspace.
1 property
ManagePartnerWorkspaceInvitesRemovePartnerTeamTargetEntity
string
The team value.
UpdateWorkspaceRequestInternalServerError
UpdateWorkspaceRolesRequestUnauthorizedError
workspace400Error
object
2 properties
TransferWorkspaceElementResponseWorkspaceElementTransfers
object
Information about the element transfer.
4 properties
workspaceId
string
workspaceRolesData
object
5 properties
ManagePartnerWorkspaceInvitesInvitePartnerAction
string
The invitepartner action.
GetWorkspaceActivityFeedDataItems
object
Information about the workspace's activity.
10 properties
WorkspaceUpdateRelatedResourcesDataItemsResource
string
The type of linked resource.
cursor
string
updateWorkspace
object
1 property
Workspace404ErrorError
object
3 properties
GetWorkspaceRolesRequestInternalServerError
GetWorkspacesWorkspaceDataVisibility
string
The workspace's visibility. [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/changing-workspace-vis…
workspaceIncludeScimQuery
string
ManagePartnerWorkspaceInvitesInvitePartnerRoleId
string
The role ID to assign to invited partners: - 4 — Viewer - 5 — Editor - 6 — Viewer and Partner Lead - 7 — Editor and Partner Lead
getWorkspaces
object
2 properties
workspaceRoles422Error
object
4 properties
GetWorkspaceWorkspace
object
Information about the workspace.
16 properties
managePartnerWorkspaceInvitesInvitePartner
object
Invite partners to a Partner Workspace.
5 properties 5 required
ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItemsStatus
string
The removal status: - REMOVED — The partner was successfully removed. - FAILED — The partner's removal failed.
GetWorkspaceRequestInternalServerError
Workspace403ErrorError
object
5 properties
ManagePartnerWorkspaceInvitesInvitePartnerTargetEntity
string
The workspace value.
ManagePartnerWorkspaceInvitesRemovePartnerAction
string
The removepartner action.
GetWorkspaceActivityFeedDataItemsAction
string
The action that occurred in the workspace.
GetWorkspaceUpdatesRequestInternalServerError
UpdateWorkspaceRolesResponseRolesItems
object
4 properties
transferWorkspaceToTeamResponseObject
object
Information about the workspace transfer.
3 properties
UpdateWorkspaceRolesRolesItemsValueItems
object
Information about the user, user group, or partner role.
2 properties 2 required
ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItemsStatus
string
The invitation status: - EMAILSENT — An invitation email was sent. - ALREADYINVITED — The user already has a pending invitation. - PARTNERADDED — The existing…
createWorkspaceResponse
object
1 property
ManagePartnerWorkspaceInvitesInvitePartnerResponseRoleDisplayName
string
The assigned role's display name.
ManagePartnerWorkspaceInvitesRequestInternalServerError
createWorkspace
object
1 property
GetWorkspaceActivityFeedRequestUnauthorizedError
partnerUserId
string
The partner's ID.
workspaceTypeQuery
string
commonErrorTypeTitleDetailStatus
object
4 properties
CreateWorkspaceUpdateRequestInternalServerError
UpdateWorkspaceRolesRolesItemsPath
string
The resource to perform the action on.
updateWorkspaceGlobalVariables
object
1 property
DeleteWorkspaceUpdateRequestInternalServerError
GetAllWorkspaceRolesRequestInternalServerError
DeleteWorkspaceRequestInternalServerError
workspace404Error
object
1 property
WorkspaceUpdateRelatedResourcesDataItems
object
2 properties 2 required
GetWorkspaceWorkspaceMocksItems
object
Information about the mock server.
4 properties
workspaceUpdateCategory
string
GetWorkspaceActivityFeedDataItemsUser
object
Information about the user that performed the activity.
4 properties
TransferWorkspaceElementResponseWorkspace
object
1 property
TransferWorkspaceElementRequestInternalServerError
workspace403Error
object
1 property
GetWorkspaceActivityFeedRequestInternalServerError
updateWorkspaceRolesResponse
object
1 property
CommonErrorTypeTitleDetailDetail
Information about the error.
workspaceRoleData
object
Information about the role.
3 properties
GetWorkspaceActivityFeedRequestForbiddenError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-workspaces-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

Postman
AE Profile APIs.io
Postman Collections API
AE Profile APIs.io
Postman Environments API
AE Profile APIs.io
Postman Monitors API
AE Profile APIs.io
Postman Webhooks API
AE Profile APIs.io
Postman Tags API
AE Profile APIs.io
Postman Billing API
AE Profile APIs.io
Postman SCIM API
AE Profile APIs.io
Postman MCP Server
AE Profile APIs.io
Postman Flows
AE Profile APIs.io
Postman Mocks API
AE Profile APIs.io
Postman analytics API
AE Profile APIs.io
#API Management#Collaboration#Workspaces
← Back to P APIs
API Details
ID
postman:workspaces-api
Base URL
https://api.getpostman.com
Docs
https://learning.postman.com/docs/developer/postman-api/intro-api/
Provider
Postman
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=workspaces-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/workspaces-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Postman Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.