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 43 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

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

This API exposes 19 operations across 11 paths, and defines 153 schemas. It is described by OpenAPI 3.2.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.2.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), workspaceUpdateData (11 properties), workspaceUpdatePostPatchResponseData (11 properties), GetWorkspaceActivityFeedDataItems (10 properties). Each schema is shown below with its type and property counts.

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

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 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
Postman API Catalog API
AE Profile APIs.io
Postman Billing API
AE Profile APIs.io
#API Management#Collaboration#Workspace
← 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.