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 Environments API

The Environments API enables programmatic management of Postman environments and global variables, including secret variables stored in the Postman Vault, so you can scope work to dev/staging/prod environments.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Configuration, Environments, and Variables. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 5 paths, and defines 100 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

10 operations 5 paths 100 schemas 1 DELETE3 GET1 PATCH4 POST1 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, API Key
Resource Areas
1

Authentication & Security 4

Postman Environments API declares 4 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). An API key is passed in the header as x-api-key (apiKeyAuth).

  • 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…
  • apiKeyAuth — Postman API key for authentication.

Paths & Operations 10

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

environments 10
GET
/environments
Get all environments
getEnvironments 2 params → 200401404500
POST
/environments
Create an environment
createEnvironment 2 params body → 200400401403411413500
GET
/environments/{environmentId}
Get an environment
getEnvironment 2 params → 200400401500
PUT
/environments/{environmentId}
Replace an environment's data
putEnvironment 2 params body → 200400401411413500
DELETE
/environments/{environmentId}
Delete an environment
deleteEnvironment 2 params → 200401404500
PATCH
/environments/{environmentId}
Update an environment
patchEnvironment 2 params body → 200400403404411413500
GET
/environments/{environmentId}/forks
Get an environment's forks
getEnvironmentForks 6 params → 200400401404500
POST
/environments/{environmentId}/forks
Create a fork
forkEnvironment 3 params body → 200401404500
POST
/environments/{environmentId}/merges
Merge a fork
mergeEnvironmentFork 2 params body → 200400401404500
POST
/environments/{environmentUid}/pulls
Pull source changes
pullEnvironment 2 params body → 200400401404500

Schemas 100

The contract defines 100 schemas that model the data the API accepts and returns. The most detailed are Environment (8 properties), getEnvironmentInfo (7 properties), environmentVaultVariables (7 properties), patchEnvironmentInfo (7 properties). Each schema is shown below with its type and property counts.

GetEnvironmentForksRequestUnauthorizedError
mergeEnvironmentFork
object
2 properties 1 required
getEnvironment
object
1 property
PatchEnvironment400ErrorDetail
Details about the occurrence of the error.
environmentUid
string
environmentForksMeta
object
The response's meta information for paginated results.
2 properties
CreateEnvironmentResponseEnvironment
object
Information about the environment.
3 properties
PutEnvironmentEnvironment
object
Information about the environment.
2 properties
CreateEnvironmentEnvironment
object
Information about the environment.
2 properties 1 required
commonErrorTypeTitleDetailStatusInstance
object
5 properties
CreateEnvironmentRequestUnauthorizedError
MergeEnvironmentForkRequestInternalServerError
MergeEnvironmentForkResponseEnvironment
object
Information about the merged environment.
1 property
Environments_patchEnvironment_Request
cursor
string
environmentVariableSource
object
Information about the source of the variable's value.
2 properties
commonErrorNameMessage
object
1 property
CommonErrorTypeTitleDetailStatusType
EnvironmentVariableSourcePostmanType
string
The variable's type: - cloud — The variable value is synced and stored in the Postman Cloud.
DeleteEnvironmentRequestNotFoundError
EnvironmentVariableSourceProvider
string
The secret's provider.
patchEnvironmentAdd
array
CommonErrorNameMessageDetailsError
object
3 properties
pullEnvironmentResponse
object
1 property
GetEnvironmentInfoValuesItems
DeleteEnvironmentEnvironment
object
Information about the environment.
2 properties
GetEnvironmentRequestBadRequestError
PatchEnvironmentInfoValuesItems
PatchEnvironmentReplaceItems
object
3 properties 3 required
patchEnvironmentName
array
putEnvironmentResponse
object
1 property
GetEnvironmentRequestInternalServerError
deleteEnvironment
object
1 property
PullEnvironmentRequestUnauthorizedError
CommonErrorNameMessageError
object
Information about the error.
2 properties
PullEnvironmentResponseEnvironment
object
Information about the merged environment.
1 property
CreateEnvironmentEnvironmentValuesItems
GetEnvironmentsRequestInternalServerError
patchEnvironmentResponse
object
1 property
PullEnvironmentRequestInternalServerError
ForkEnvironmentRequestInternalServerError
getEnvironmentsInfo
object
Information about the environment.
7 properties
environmentForkInfo
object
Information about the forked environment.
5 properties
PutEnvironmentRequestBadRequestError
PutEnvironmentRequestInternalServerError
GetEnvironmentsRequestUnauthorizedError
ForkEnvironmentResponseEnvironment
object
Information about the forked environment.
3 properties
ForkEnvironmentRequestUnauthorizedError
pullEnvironment
object
1 property 1 required
PatchEnvironmentRemoveItems
object
2 properties 2 required
createEnvironmentResponse
object
1 property
mergeEnvironmentForkResponse
object
1 property
createEnvironment
object
1 property
getEnvironments
object
1 property
commonErrorTypeTitleDetailStatus
object
4 properties
patchEnvironmentRemove
array
workspaceId
string
PatchEnvironmentNameItems
object
Information about the environment.
3 properties 3 required
CreateEnvironmentRequestBadRequestError
PatchEnvironmentAddItems
object
3 properties 3 required
PutEnvironmentEnvironmentValuesItems
ascDesc
string
sortByCreatedAt
string
MergeEnvironmentForkRequestUnauthorizedError
PatchEnvironmentRequestNotFoundError
getEnvironmentInfo
object
Information about the environment.
7 properties
GetEnvironmentForksRequestInternalServerError
GetEnvironmentRequestUnauthorizedError
PutEnvironmentRequestUnauthorizedError
environmentVariables
object
Information about the variable.
5 properties
PatchEnvironmentRequestInternalServerError
environmentId
string
commonErrorNameMessageDetails
object
1 property
commonErrorTypeTitleDetail
object
3 properties
environmentSecret
boolean
If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source field.
patchEnvironmentReplace
array
CreateEnvironmentRequestInternalServerError
CommonErrorTypeTitleDetailDetail
Information about the error.
EnvironmentVariablesType
string
The variable's type: - secret — The variable value is masked. - default — The variable value is visible in plain text.
DeleteEnvironmentRequestInternalServerError
GetEnvironmentsRequestNotFoundError
EnvironmentVaultVariablesType
string
The variable's type: - secret — The variable value is masked. - default — The variable value is visible in plain text.
CommonErrorNameMessageDetailsErrorDetails
Information about the error.
environmentVaultVariables
object
Information about the variable stored in the Postman Vault. This property only returns when a variable is defined as secret.
7 properties
PatchEnvironmentAddItemsValue
CreateEnvironmentRequestForbiddenError
getEnvironmentForks
object
2 properties
PutEnvironmentResponseEnvironment
object
Information about the environment.
3 properties
patchEnvironment400Error
object
5 properties
forkEnvironment
object
1 property 1 required
forkEnvironmentResponse
object
1 property
putEnvironment
object
1 property
patchEnvironmentInfo
object
Information about the environment.
7 properties
DeleteEnvironmentRequestUnauthorizedError
limit
integer
EnvironmentVariableSourcePostman
object
Information about the Postman-specific source of the variable's value.
3 properties
EnvironmentListItem
object
Abbreviated environment information returned in list responses.
7 properties
EnvironmentVariable
object
A key-value variable within an environment.
4 properties
Environment
object
Full environment details including variables.
8 properties
EnvironmentInput
object
Input format for creating or updating an environment.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-environments-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

Postman
AE Profile APIs.io
Postman Collections API
AE Profile APIs.io
Postman Workspaces 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
#Configuration#Environments#Variables
← Back to P APIs
API Details
ID
postman:environments-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=environments-api-2&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/environments-api-2"

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 Environments 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.