> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt.

# Postman API Reference Overview

The Postman API enables you to programmatically access data stored in your Postman account. This includes collections, environments, workspaces, and more. Use the Postman API to integrate Postman with your development workflow and automate tasks in your CI/CD pipelines.

For information about Postman, see [Postman quick start](https://learning.postman.com/docs/getting-started/quick-start/).

**Note:**

Certain endpoints may be unavailable depending on your region and/or Postman plan.

## Getting started

### EU users

For users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.

## About the Postman API

* You must use a valid API Key to send requests to the API endpoints.
* The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).
* The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.
* The API returns requests responses in JSON format.
* The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.
* For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.

### IDs and UIDs

All items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:

* An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.
* The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID, where `12345678` is the user's ID and  `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.

### Enum values

Any documented enum values should be considered partial lists and may change over time.

### 403 response for unavailable features

Depending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the "This feature isn't available in your region." detail.

### 503 response

An HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.

If the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).

### Deprecated endpoints

Endpoints marked as deprecated are no longer supported and may be removed in future versions of the API. They exist in the documentation for reference purposes only.

## Authentication

Postman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://go.postman.co/settings/me/api-keys) section of your Postman account settings.

You must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.postman.com/docs/environments). The Postman API [collection](https://www.postman.com/docs/collections) will use it to make API calls.

### SCIM authentication

While all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).

### Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.

## Rate and usage limits

API access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**.

* Postman Monitors, as well as the GET `/collections`, GET `/workspaces`, and GET `/workspaces/{id}` endpoints have a rate limit of **10 calls in 10 seconds**.
* Workspace updates endpoints have a rate limit of **20 requests per minute per user**.
* The POST `/import/openapi` endpoint has a rate limit of **10 requests in 10 seconds**.

Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/). Every API response includes headers to help you identify the status of your use limits. For more information, see [Track Postman API call limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).

When you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:

* `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API. The response header also includes the `X-RateLimit-RetryAfter` and `Retry-After` responses when you go over your limit, which returns the seconds remaining until you can make another request.
* `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.

## Support

For help regarding accessing the Postman API, you can:

* Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.
* Reach out to the [Postman community](https://community.postman.com/).
* Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).

## Policies

* [Postman Terms of Service](http://www.postman.com/legal/terms/)
* [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)

> Learn how to use Postman. Search the docs and support resources!


## API Docs

- API Reference > Analytics [Get analytics data](https://learning.postman.com/api-docs/api-reference/analytics/get-analytics-data.md)
- API Reference > Analytics [Get analytics metadata](https://learning.postman.com/api-docs/api-reference/analytics/get-analytics-metadata.md)
- API Reference > APIs [Get all APIs](https://learning.postman.com/api-docs/api-reference/ap-is/get-apis.md)
- API Reference > APIs [Create an API](https://learning.postman.com/api-docs/api-reference/ap-is/create-api.md)
- API Reference > APIs [Get an API](https://learning.postman.com/api-docs/api-reference/ap-is/get-api.md)
- API Reference > APIs [Update an API](https://learning.postman.com/api-docs/api-reference/ap-is/update-api.md)
- API Reference > APIs [Delete an API](https://learning.postman.com/api-docs/api-reference/ap-is/delete-api.md)
- API Reference > APIs [Add a collection](https://learning.postman.com/api-docs/api-reference/ap-is/add-api-collection.md)
- API Reference > APIs [Get a collection](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-collection.md)
- API Reference > APIs [Get a collection's comments](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-collection-comments.md)
- API Reference > APIs [Create a collection comment](https://learning.postman.com/api-docs/api-reference/ap-is/create-api-collection-comment.md)
- API Reference > APIs [Update a collection's comment](https://learning.postman.com/api-docs/api-reference/ap-is/update-api-collection-comment.md)
- API Reference > APIs [Delete a collection's comment](https://learning.postman.com/api-docs/api-reference/ap-is/delete-api-collection-comment.md)
- API Reference > APIs [Sync collection with schema](https://learning.postman.com/api-docs/api-reference/ap-is/sync-collection-with-schema.md)
- API Reference > APIs [Get an API's comments](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-comments.md)
- API Reference > APIs [Create an API comment](https://learning.postman.com/api-docs/api-reference/ap-is/create-api-comment.md)
- API Reference > APIs [Update an API's comment](https://learning.postman.com/api-docs/api-reference/ap-is/update-api-comment.md)
- API Reference > APIs [Delete an API's comment](https://learning.postman.com/api-docs/api-reference/ap-is/delete-api-comment.md)
- API Reference > APIs [Create a schema](https://learning.postman.com/api-docs/api-reference/ap-is/create-api-schema.md)
- API Reference > APIs [Get a schema](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-schema.md)
- API Reference > APIs [Get schema files](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-schema-files.md)
- API Reference > APIs [Get schema file contents](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-schema-file-contents.md)
- API Reference > APIs [Create or update a schema file](https://learning.postman.com/api-docs/api-reference/ap-is/create-update-api-schema-file.md)
- API Reference > APIs [Delete a schema file](https://learning.postman.com/api-docs/api-reference/ap-is/delete-api-schema-file.md)
- API Reference > APIs [Get status of an asynchronous task](https://learning.postman.com/api-docs/api-reference/ap-is/get-status-of-an-async-api-task.md)
- API Reference > APIs [Get all versions](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-versions.md)
- API Reference > APIs [Create a version](https://learning.postman.com/api-docs/api-reference/ap-is/create-api-version.md)
- API Reference > APIs [Get a version](https://learning.postman.com/api-docs/api-reference/ap-is/get-api-version.md)
- API Reference > APIs [Update a version](https://learning.postman.com/api-docs/api-reference/ap-is/update-api-version.md)
- API Reference > APIs [Delete a version](https://learning.postman.com/api-docs/api-reference/ap-is/delete-api-version.md)
- API Reference > API Catalog [Get discovered services](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-discovery-services.md)
- API Reference > API Catalog [Add discovered services to the API Catalog](https://learning.postman.com/api-docs/api-reference/api-catalog/post-api-catalog-discovery-services.md)
- API Reference > API Catalog [Get a discovered service's information](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-discovery-service.md)
- API Reference > API Catalog [Get all services](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-services.md)
- API Reference > API Catalog [Get a service by ID](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-service.md)
- API Reference > API Catalog [Get a service's endpoints](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-service-endpoints.md)
- API Reference > API Catalog [Get a service's monitor runs](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-service-monitor-runs.md)
- API Reference > API Catalog [Get a service's specification lints](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-service-specification-lints.md)
- API Reference > API Catalog [Get a service's CI runs](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-service-ci-runs.md)
- API Reference > API Catalog [Get all system environments](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-system-environments.md)
- API Reference > API Catalog [Create a system environment](https://learning.postman.com/api-docs/api-reference/api-catalog/create-api-catalog-system-environment.md)
- API Reference > API Catalog [Get a system environment](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-system-environment.md)
- API Reference > API Catalog [Update a system environment](https://learning.postman.com/api-docs/api-reference/api-catalog/update-api-catalog-system-environment.md)
- API Reference > API Catalog [Get a system environment's associations](https://learning.postman.com/api-docs/api-reference/api-catalog/get-api-catalog-system-environment-associations.md)
- API Reference > API Catalog [Add system environment associations](https://learning.postman.com/api-docs/api-reference/api-catalog/add-api-catalog-system-environment-associations.md)
- API Reference > API Catalog [Remove system environment associations](https://learning.postman.com/api-docs/api-reference/api-catalog/remove-api-catalog-system-environment-associations.md)
- API Reference > API Governance [Get all custom functions](https://learning.postman.com/api-docs/api-reference/api-governance/get-all-custom-functions.md)
- API Reference > API Governance [Create a custom function](https://learning.postman.com/api-docs/api-reference/api-governance/create-custom-function.md)
- API Reference > API Governance [Get a custom function](https://learning.postman.com/api-docs/api-reference/api-governance/get-custom-function.md)
- API Reference > API Governance [Delete a custom function](https://learning.postman.com/api-docs/api-reference/api-governance/delete-custom-function.md)
- API Reference > API Governance [Update a custom function](https://learning.postman.com/api-docs/api-reference/api-governance/update-custom-function.md)
- API Reference > API Governance [Get all governance groups](https://learning.postman.com/api-docs/api-reference/api-governance/get-all-governance-groups.md)
- API Reference > API Governance [Create a governance group](https://learning.postman.com/api-docs/api-reference/api-governance/create-governance-group.md)
- API Reference > API Governance [Delete a governance group](https://learning.postman.com/api-docs/api-reference/api-governance/delete-governance-group.md)
- API Reference > API Governance [Update a governance group](https://learning.postman.com/api-docs/api-reference/api-governance/update-governance-group.md)
- API Reference > API Governance [Get a governance group's ruleset assignments](https://learning.postman.com/api-docs/api-reference/api-governance/get-governance-group-assignments.md)
- API Reference > API Governance [Get workspaces in a governance group](https://learning.postman.com/api-docs/api-reference/api-governance/get-governance-group-workspaces.md)
- API Reference > API Governance [Assign and unassign workspaces](https://learning.postman.com/api-docs/api-reference/api-governance/update-governance-group-workspaces.md)
- API Reference > API Governance [Get all rulesets](https://learning.postman.com/api-docs/api-reference/api-governance/get-all-rulesets.md)
- API Reference > API Governance [Create a ruleset](https://learning.postman.com/api-docs/api-reference/api-governance/create-ruleset.md)
- API Reference > API Governance [Get a ruleset](https://learning.postman.com/api-docs/api-reference/api-governance/get-ruleset.md)
- API Reference > API Governance [Delete a ruleset](https://learning.postman.com/api-docs/api-reference/api-governance/delete-ruleset.md)
- API Reference > API Governance [Update a ruleset](https://learning.postman.com/api-docs/api-reference/api-governance/update-ruleset.md)
- API Reference > API Governance [Get ruleset assignments](https://learning.postman.com/api-docs/api-reference/api-governance/get-ruleset-assignments.md)
- API Reference > API Governance [Assign a ruleset](https://learning.postman.com/api-docs/api-reference/api-governance/create-ruleset-assignment.md)
- API Reference > API Governance [Delete a ruleset assignment](https://learning.postman.com/api-docs/api-reference/api-governance/delete-ruleset-assignment.md)
- API Reference > API Governance [API definition security validation](https://learning.postman.com/api-docs/api-reference/api-governance/schema-security-validation.md)
- API Reference > Audit Logs [Get team audit logs](https://learning.postman.com/api-docs/api-reference/audit-logs/get-audit-logs.md)
- API Reference > Audit Logs [Get all audit log event actions](https://learning.postman.com/api-docs/api-reference/audit-logs/get-audit-log-event-actions.md)
- API Reference > Billing [Get accounts](https://learning.postman.com/api-docs/api-reference/billing/get-accounts.md)
- API Reference > Billing [List account invoices](https://learning.postman.com/api-docs/api-reference/billing/get-account-invoices.md)
- API Reference > Collection Access Keys [Get collection access keys](https://learning.postman.com/api-docs/api-reference/collection-access-keys/get-collection-access-keys.md)
- API Reference > Collection Access Keys [Delete a collection access key](https://learning.postman.com/api-docs/api-reference/collection-access-keys/delete-collection-access-key.md)
- API Reference > Collection Folders [Get a folder's comments](https://learning.postman.com/api-docs/api-reference/collection-folders/get-folder-comments.md)
- API Reference > Collection Folders [Create a folder comment](https://learning.postman.com/api-docs/api-reference/collection-folders/create-folder-comment.md)
- API Reference > Collection Folders [Update a folder's comment](https://learning.postman.com/api-docs/api-reference/collection-folders/update-folder-comment.md)
- API Reference > Collection Folders [Delete a folder's comment](https://learning.postman.com/api-docs/api-reference/collection-folders/delete-folder-comment.md)
- API Reference > Collection Items [Create a folder](https://learning.postman.com/api-docs/api-reference/collection-items/create-collection-folder.md)
- API Reference > Collection Items [Create a request](https://learning.postman.com/api-docs/api-reference/collection-items/create-collection-request.md)
- API Reference > Collection Items [Create a response](https://learning.postman.com/api-docs/api-reference/collection-items/create-collection-response.md)
- API Reference > Collection Items [Get a folder](https://learning.postman.com/api-docs/api-reference/collection-items/get-collection-folder.md)
- API Reference > Collection Items [Update a folder](https://learning.postman.com/api-docs/api-reference/collection-items/update-collection-folder.md)
- API Reference > Collection Items [Delete a folder](https://learning.postman.com/api-docs/api-reference/collection-items/delete-collection-folder.md)
- API Reference > Collection Items [Get a request](https://learning.postman.com/api-docs/api-reference/collection-items/get-collection-request.md)
- API Reference > Collection Items [Update a request](https://learning.postman.com/api-docs/api-reference/collection-items/update-collection-request.md)
- API Reference > Collection Items [Delete a request](https://learning.postman.com/api-docs/api-reference/collection-items/delete-collection-request.md)
- API Reference > Collection Items [Get a response](https://learning.postman.com/api-docs/api-reference/collection-items/get-collection-response.md)
- API Reference > Collection Items [Update a response](https://learning.postman.com/api-docs/api-reference/collection-items/update-collection-response.md)
- API Reference > Collection Items [Delete a response](https://learning.postman.com/api-docs/api-reference/collection-items/delete-collection-response.md)
- API Reference > Collection Requests [Get a request's comments](https://learning.postman.com/api-docs/api-reference/collection-requests/get-request-comments.md)
- API Reference > Collection Requests [Create a request comment](https://learning.postman.com/api-docs/api-reference/collection-requests/create-request-comment.md)
- API Reference > Collection Requests [Update a request's comment](https://learning.postman.com/api-docs/api-reference/collection-requests/update-request-comment.md)
- API Reference > Collection Requests [Delete a request's comment](https://learning.postman.com/api-docs/api-reference/collection-requests/delete-request-comment.md)
- API Reference > Collection Responses [Get a response's comments](https://learning.postman.com/api-docs/api-reference/collection-responses/get-response-comments.md)
- API Reference > Collection Responses [Create a response comment](https://learning.postman.com/api-docs/api-reference/collection-responses/create-response-comment.md)
- API Reference > Collection Responses [Update a response's comment](https://learning.postman.com/api-docs/api-reference/collection-responses/update-response-comment.md)
- API Reference > Collection Responses [Delete a response's comment](https://learning.postman.com/api-docs/api-reference/collection-responses/delete-response-comment.md)
- API Reference > Collections [Merge or pull changes into a collection fork](https://learning.postman.com/api-docs/api-reference/collections/async-merge-pull-collection-fork.md)
- API Reference > Collections [Get merge or pull task status](https://learning.postman.com/api-docs/api-reference/collections/async-merge-pull-collection-task-status.md)
- API Reference > Collections [Get all collections](https://learning.postman.com/api-docs/api-reference/collections/get-collections.md)
- API Reference > Collections [Create a collection](https://learning.postman.com/api-docs/api-reference/collections/create-collection.md)
- API Reference > Collections [Get all forked collections](https://learning.postman.com/api-docs/api-reference/collections/get-collections-forked-by-user.md)
- API Reference > Collections [Create a fork](https://learning.postman.com/api-docs/api-reference/collections/create-collection-fork.md)
- API Reference > Collections [Merge a fork](https://learning.postman.com/api-docs/api-reference/collections/merge-collection-fork.md)
- API Reference > Collections [Get a collection](https://learning.postman.com/api-docs/api-reference/collections/get-collection.md)
- API Reference > Collections [Replace a collection's data](https://learning.postman.com/api-docs/api-reference/collections/put-collection.md)
- API Reference > Collections [Delete a collection](https://learning.postman.com/api-docs/api-reference/collections/delete-collection.md)
- API Reference > Collections [Update part of a collection](https://learning.postman.com/api-docs/api-reference/collections/patch-collection.md)
- API Reference > Collections [Get a collection's comments](https://learning.postman.com/api-docs/api-reference/collections/get-collection-comments.md)
- API Reference > Collections [Create a collection comment](https://learning.postman.com/api-docs/api-reference/collections/create-collection-comment.md)
- API Reference > Collections [Update a collection's comment](https://learning.postman.com/api-docs/api-reference/collections/update-collection-comment.md)
- API Reference > Collections [Delete a collection's comment](https://learning.postman.com/api-docs/api-reference/collections/delete-collection-comment.md)
- API Reference > Collections [Duplicate a collection](https://learning.postman.com/api-docs/api-reference/collections/duplicate-collection.md)
- API Reference > Collections [Get a collection's forks](https://learning.postman.com/api-docs/api-reference/collections/get-collection-forks.md)
- API Reference > Collections [Publish documentation](https://learning.postman.com/api-docs/api-reference/collections/publish-documentation.md)
- API Reference > Collections [Unpublish documentation](https://learning.postman.com/api-docs/api-reference/collections/unpublish-documentation.md)
- API Reference > Collections [Pull source changes](https://learning.postman.com/api-docs/api-reference/collections/pull-collection-changes.md)
- API Reference > Collections [Get a collection's pull requests](https://learning.postman.com/api-docs/api-reference/collections/get-collection-pull-requests.md)
- API Reference > Collections [Create a pull request](https://learning.postman.com/api-docs/api-reference/collections/create-collection-pull-request.md)
- API Reference > Collections [Get a collection's roles](https://learning.postman.com/api-docs/api-reference/collections/get-collection-roles.md)
- API Reference > Collections [Update a collection's roles](https://learning.postman.com/api-docs/api-reference/collections/update-collection-roles.md)
- API Reference > Collections [Get source collection's status](https://learning.postman.com/api-docs/api-reference/collections/get-source-collection-status.md)
- API Reference > Collections [Transform collection to OpenAPI](https://learning.postman.com/api-docs/api-reference/collections/transform-collection-to-open-api.md)
- API Reference > Collections [Transfer folders](https://learning.postman.com/api-docs/api-reference/collections/transfer-collection-folders.md)
- API Reference > Collections [Transfer requests](https://learning.postman.com/api-docs/api-reference/collections/transfer-collection-requests.md)
- API Reference > Collections [Transfer responses](https://learning.postman.com/api-docs/api-reference/collections/transfer-collection-responses.md)
- API Reference > Collections [Get duplication task status](https://learning.postman.com/api-docs/api-reference/collections/get-duplicate-collection-task-status.md)
- API Reference > Collections [Get async collection update status](https://learning.postman.com/api-docs/api-reference/collections/get-collection-updates-tasks.md)
- API Reference > Comments [Resolve a comment thread](https://learning.postman.com/api-docs/api-reference/comments/resolve-comment-thread.md)
- API Reference > Components [Get all components](https://learning.postman.com/api-docs/api-reference/components/get-all-components.md)
- API Reference > Components [Create a component](https://learning.postman.com/api-docs/api-reference/components/create-component.md)
- API Reference > Components [Get a component](https://learning.postman.com/api-docs/api-reference/components/get-component.md)
- API Reference > Components [Update a component](https://learning.postman.com/api-docs/api-reference/components/update-component.md)
- API Reference > Components [Get a component draft](https://learning.postman.com/api-docs/api-reference/components/get-component-draft.md)
- API Reference > Components [Update a component draft](https://learning.postman.com/api-docs/api-reference/components/update-component-draft.md)
- API Reference > Components [Get all component versions](https://learning.postman.com/api-docs/api-reference/components/get-component-versions.md)
- API Reference > Components [Create a component version](https://learning.postman.com/api-docs/api-reference/components/create-component-version.md)
- API Reference > Components [Get a component version](https://learning.postman.com/api-docs/api-reference/components/get-component-version.md)
- API Reference > Context Graph [Submit a Context Graph ask](https://learning.postman.com/api-docs/api-reference/context-graph/submit-context-graph-ask.md)
- API Reference > Context Graph [Get a Context Graph ask](https://learning.postman.com/api-docs/api-reference/context-graph/get-context-graph-ask.md)
- API Reference > Environments [Get all environments](https://learning.postman.com/api-docs/api-reference/environments/get-environments.md)
- API Reference > Environments [Create an environment](https://learning.postman.com/api-docs/api-reference/environments/create-environment.md)
- API Reference > Environments [Get an environment](https://learning.postman.com/api-docs/api-reference/environments/get-environment.md)
- API Reference > Environments [Replace an environment's data](https://learning.postman.com/api-docs/api-reference/environments/put-environment.md)
- API Reference > Environments [Delete an environment](https://learning.postman.com/api-docs/api-reference/environments/delete-environment.md)
- API Reference > Environments [Update an environment](https://learning.postman.com/api-docs/api-reference/environments/patch-environment.md)
- API Reference > Environments [Get an environment's forks](https://learning.postman.com/api-docs/api-reference/environments/get-environment-forks.md)
- API Reference > Environments [Create a fork](https://learning.postman.com/api-docs/api-reference/environments/fork-environment.md)
- API Reference > Environments [Merge a fork](https://learning.postman.com/api-docs/api-reference/environments/merge-environment-fork.md)
- API Reference > Environments [Pull source changes](https://learning.postman.com/api-docs/api-reference/environments/pull-environment.md)
- API Reference > Groups [Get all groups](https://learning.postman.com/api-docs/api-reference/groups/get-groups.md)
- API Reference > Groups [Get a group](https://learning.postman.com/api-docs/api-reference/groups/get-group.md)
- API Reference > Import [Import an OpenAPI definition](https://learning.postman.com/api-docs/api-reference/import/open-api-definition.md)
- API Reference > Mocks [Get all mock servers](https://learning.postman.com/api-docs/api-reference/mocks/get-mocks.md)
- API Reference > Mocks [Create a mock server](https://learning.postman.com/api-docs/api-reference/mocks/create-mock.md)
- API Reference > Mocks [Get a mock server](https://learning.postman.com/api-docs/api-reference/mocks/get-mock.md)
- API Reference > Mocks [Update a mock server](https://learning.postman.com/api-docs/api-reference/mocks/update-mock.md)
- API Reference > Mocks [Delete a mock server](https://learning.postman.com/api-docs/api-reference/mocks/delete-mock.md)
- API Reference > Mocks [Get a mock server's call logs](https://learning.postman.com/api-docs/api-reference/mocks/get-mock-call-logs.md)
- API Reference > Mocks [Publish a mock server](https://learning.postman.com/api-docs/api-reference/mocks/publish-mock.md)
- API Reference > Mocks [Unpublish a mock server](https://learning.postman.com/api-docs/api-reference/mocks/unpublish-mock.md)
- API Reference > Mocks [Get all server responses](https://learning.postman.com/api-docs/api-reference/mocks/get-mock-server-responses.md)
- API Reference > Mocks [Create a server response](https://learning.postman.com/api-docs/api-reference/mocks/create-mock-server-response.md)
- API Reference > Mocks [Get a server response](https://learning.postman.com/api-docs/api-reference/mocks/get-mock-server-response.md)
- API Reference > Mocks [Update a server response](https://learning.postman.com/api-docs/api-reference/mocks/update-mock-server-response.md)
- API Reference > Mocks [Delete a server response](https://learning.postman.com/api-docs/api-reference/mocks/delete-mock-server-response.md)
- API Reference > Monitors [Get all monitors](https://learning.postman.com/api-docs/api-reference/monitors/get-monitors.md)
- API Reference > Monitors [Create a monitor](https://learning.postman.com/api-docs/api-reference/monitors/create-monitor.md)
- API Reference > Monitors [Get a monitor](https://learning.postman.com/api-docs/api-reference/monitors/get-monitor.md)
- API Reference > Monitors [Update a monitor](https://learning.postman.com/api-docs/api-reference/monitors/update-monitor.md)
- API Reference > Monitors [Delete a monitor](https://learning.postman.com/api-docs/api-reference/monitors/delete-monitor.md)
- API Reference > Monitors [Run a monitor](https://learning.postman.com/api-docs/api-reference/monitors/run-monitor.md)
- API Reference > Monitors [Get all runner instances](https://learning.postman.com/api-docs/api-reference/monitors/get-runner-instances.md)
- API Reference > Monitors [Get runner metrics](https://learning.postman.com/api-docs/api-reference/monitors/get-runner-metrics.md)
- API Reference > OAuth 2.0 [Generate an OAuth Token](https://learning.postman.com/api-docs/api-reference/o-auth-2-0/generate-oauth-token.md)
- API Reference > OAuth 2.0 [Revoke an OAuth Token](https://learning.postman.com/api-docs/api-reference/o-auth-2-0/revoke-oauth-token.md)
- API Reference > Packages [Get all packages](https://learning.postman.com/api-docs/api-reference/packages/get-packages.md)
- API Reference > Packages [Create a package](https://learning.postman.com/api-docs/api-reference/packages/create-package.md)
- API Reference > Packages [Get a package](https://learning.postman.com/api-docs/api-reference/packages/get-package.md)
- API Reference > Packages [Delete a package](https://learning.postman.com/api-docs/api-reference/packages/delete-package.md)
- API Reference > Packages [Update a package](https://learning.postman.com/api-docs/api-reference/packages/update-package.md)
- API Reference > Postbot [Generate a tool](https://learning.postman.com/api-docs/api-reference/postbot/generate-tool.md)
- API Reference > Private API Network [Get all workspaces](https://learning.postman.com/api-docs/api-reference/private-api-network/list-private-network-workspaces.md)
- API Reference > Private API Network [Add a workspace](https://learning.postman.com/api-docs/api-reference/private-api-network/add-workspace-to-private-network.md)
- API Reference > Private API Network [Update an element or folder](https://learning.postman.com/api-docs/api-reference/private-api-network/update-pan-element-or-folder.md)
- API Reference > Private API Network [Remove a workspace](https://learning.postman.com/api-docs/api-reference/private-api-network/remove-workspace-from-private-network.md)
- API Reference > Private API Network [Get all add requests](https://learning.postman.com/api-docs/api-reference/private-api-network/list-private-network-add-requests.md)
- API Reference > Private API Network [Respond to an add request](https://learning.postman.com/api-docs/api-reference/private-api-network/respond-private-network-add-request.md)
- API Reference > Pull Requests [Get a pull request](https://learning.postman.com/api-docs/api-reference/pull-requests/get-pull-request.md)
- API Reference > Pull Requests [Update a pull request](https://learning.postman.com/api-docs/api-reference/pull-requests/update-pull-request.md)
- API Reference > Pull Requests [Review a pull request](https://learning.postman.com/api-docs/api-reference/pull-requests/review-pull-request.md)
- API Reference > SCIM [Get all groups](https://learning.postman.com/api-docs/api-reference/scim/get-scim-group-resources.md)
- API Reference > SCIM [Create a group](https://learning.postman.com/api-docs/api-reference/scim/create-scim-group.md)
- API Reference > SCIM [Get a group](https://learning.postman.com/api-docs/api-reference/scim/get-scim-group-resource.md)
- API Reference > SCIM [Delete a group](https://learning.postman.com/api-docs/api-reference/scim/delete-scim-group.md)
- API Reference > SCIM [Update a group](https://learning.postman.com/api-docs/api-reference/scim/update-group.md)
- API Reference > SCIM [Get resource types](https://learning.postman.com/api-docs/api-reference/scim/get-scim-resource-types.md)
- API Reference > SCIM [Get service provider configuration](https://learning.postman.com/api-docs/api-reference/scim/get-scim-service-provider-config.md)
- API Reference > SCIM [Get all users](https://learning.postman.com/api-docs/api-reference/scim/get-scim-user-resources.md)
- API Reference > SCIM [Create a user](https://learning.postman.com/api-docs/api-reference/scim/create-scim-user.md)
- API Reference > SCIM [Get a user](https://learning.postman.com/api-docs/api-reference/scim/get-scim-user-resource.md)
- API Reference > SCIM [Update a user](https://learning.postman.com/api-docs/api-reference/scim/update-scim-user.md)
- API Reference > SDKs [Get all SDKs](https://learning.postman.com/api-docs/api-reference/sd-ks/get-sdks.md)
- API Reference > SDKs [Generate an SDK](https://learning.postman.com/api-docs/api-reference/sd-ks/create-sdk.md)
- API Reference > SDKs [Get an SDK](https://learning.postman.com/api-docs/api-reference/sd-ks/get-sdk.md)
- API Reference > SDKs [Delete an SDK](https://learning.postman.com/api-docs/api-reference/sd-ks/delete-sdk.md)
- API Reference > SDKs [Get an SDK's download URL](https://learning.postman.com/api-docs/api-reference/sd-ks/get-sdk-download-url.md)
- API Reference > SDKs [Get all SDK Git connections](https://learning.postman.com/api-docs/api-reference/sd-ks/get-sdk-git-connections.md)
- API Reference > SDKs [Connect a Git repository to an SDK](https://learning.postman.com/api-docs/api-reference/sd-ks/create-sdk-git-connection.md)
- API Reference > SDKs [Get an SDK Git connection](https://learning.postman.com/api-docs/api-reference/sd-ks/get-sdk-git-connection.md)
- API Reference > SDKs [Update an SDK Git connection](https://learning.postman.com/api-docs/api-reference/sd-ks/update-sdk-git-connection.md)
- API Reference > SDKs [Get an SDK Git connection's pull requests](https://learning.postman.com/api-docs/api-reference/sd-ks/get-sdk-git-connection-pull-requests.md)
- API Reference > Search [Search Postman resources](https://learning.postman.com/api-docs/api-reference/search/postman-resources.md)
- API Reference > Secret Scanner [Search detected secrets](https://learning.postman.com/api-docs/api-reference/secret-scanner/detected-secrets-queries.md)
- API Reference > Secret Scanner [Update detected secret resolution status](https://learning.postman.com/api-docs/api-reference/secret-scanner/update-detected-secret-resolutions.md)
- API Reference > Secret Scanner [Get detected secrets locations](https://learning.postman.com/api-docs/api-reference/secret-scanner/get-detected-secrets-locations.md)
- API Reference > Secret Scanner [Get secret types](https://learning.postman.com/api-docs/api-reference/secret-scanner/get-secret-types.md)
- API Reference > Specs [Get status of API Builder to Spec Hub migration](https://learning.postman.com/api-docs/api-reference/specs/get-migration-status.md)
- API Reference > Specs [Migrate API Builder API to Spec Hub](https://learning.postman.com/api-docs/api-reference/specs/migrate-api-to-spec-hub.md)
- API Reference > Specs [Get generated spec](https://learning.postman.com/api-docs/api-reference/specs/get-generated-collection-specs.md)
- API Reference > Specs [Generate spec from collection](https://learning.postman.com/api-docs/api-reference/specs/generate-spec-from-collection.md)
- API Reference > Specs [Sync collection with spec](https://learning.postman.com/api-docs/api-reference/specs/sync-collection-with-spec.md)
- API Reference > Specs [Get status of an async spec task](https://learning.postman.com/api-docs/api-reference/specs/get-async-spec-task-status.md)
- API Reference > Specs [Get all specs](https://learning.postman.com/api-docs/api-reference/specs/get-all-specs.md)
- API Reference > Specs [Create a spec](https://learning.postman.com/api-docs/api-reference/specs/create-spec.md)
- API Reference > Specs [Get a spec](https://learning.postman.com/api-docs/api-reference/specs/get-spec.md)
- API Reference > Specs [Delete a spec](https://learning.postman.com/api-docs/api-reference/specs/delete-spec.md)
- API Reference > Specs [Update a spec's properties](https://learning.postman.com/api-docs/api-reference/specs/update-spec-properties.md)
- API Reference > Specs [Update spec sync options](https://learning.postman.com/api-docs/api-reference/specs/update-spec-sync-options.md)
- API Reference > Specs [Get a spec's definition](https://learning.postman.com/api-docs/api-reference/specs/get-spec-definition.md)
- API Reference > Specs [Get a spec's files](https://learning.postman.com/api-docs/api-reference/specs/get-spec-files.md)
- API Reference > Specs [Create a spec file](https://learning.postman.com/api-docs/api-reference/specs/create-spec-file.md)
- API Reference > Specs [Get a spec file](https://learning.postman.com/api-docs/api-reference/specs/get-spec-file.md)
- API Reference > Specs [Delete a spec file](https://learning.postman.com/api-docs/api-reference/specs/delete-spec-file.md)
- API Reference > Specs [Update a spec file](https://learning.postman.com/api-docs/api-reference/specs/update-spec-file.md)
- API Reference > Specs [Get a spec's generated collections](https://learning.postman.com/api-docs/api-reference/specs/get-spec-collections.md)
- API Reference > Specs [Generate a collection from spec](https://learning.postman.com/api-docs/api-reference/specs/generate-collection.md)
- API Reference > Specs [Sync spec with collection](https://learning.postman.com/api-docs/api-reference/specs/sync-spec-with-collection.md)
- API Reference > Specs [Get a version tag](https://learning.postman.com/api-docs/api-reference/specs/get-spec-version-tag.md)
- API Reference > Specs [Get a specification's version tags](https://learning.postman.com/api-docs/api-reference/specs/get-spec-version-tags.md)
- API Reference > Specs [Create a version tag](https://learning.postman.com/api-docs/api-reference/specs/create-spec-version-tag.md)
- API Reference > Tags [Get an API's tags](https://learning.postman.com/api-docs/api-reference/tags/get-api-tags.md)
- API Reference > Tags [Update an API's tags](https://learning.postman.com/api-docs/api-reference/tags/update-api-tags.md)
- API Reference > Tags [Get a collection's tags](https://learning.postman.com/api-docs/api-reference/tags/get-collection-tags.md)
- API Reference > Tags [Update a collection's tags](https://learning.postman.com/api-docs/api-reference/tags/update-collection-tags.md)
- API Reference > Tags [Get elements by tag](https://learning.postman.com/api-docs/api-reference/tags/get-tagged-entities.md)
- API Reference > Tags [Get a workspace's tags](https://learning.postman.com/api-docs/api-reference/tags/get-workspace-tags.md)
- API Reference > Tags [Update a workspace's tags](https://learning.postman.com/api-docs/api-reference/tags/update-workspace-tags.md)
- API Reference > Teams [Get all teams](https://learning.postman.com/api-docs/api-reference/teams/get-teams.md)
- API Reference > Teams [Create a team](https://learning.postman.com/api-docs/api-reference/teams/create-team.md)
- API Reference > Teams [Get a team](https://learning.postman.com/api-docs/api-reference/teams/get-team.md)
- API Reference > Teams [Get a team's access requests](https://learning.postman.com/api-docs/api-reference/teams/get-team-access-requests.md)
- API Reference > Teams [Create an access request](https://learning.postman.com/api-docs/api-reference/teams/create-access-request.md)
- API Reference > Teams [Approve or deny an access request](https://learning.postman.com/api-docs/api-reference/teams/approve-deny-access-request.md)
- API Reference > Teams [Manage team member roles](https://learning.postman.com/api-docs/api-reference/teams/manage-team-member-roles.md)
- API Reference > Teams [Remove team members](https://learning.postman.com/api-docs/api-reference/teams/remove-team-members.md)
- API Reference > Teams [Get a team's settings](https://learning.postman.com/api-docs/api-reference/teams/get-team-settings.md)
- API Reference > Teams [Update team settings](https://learning.postman.com/api-docs/api-reference/teams/update-team-settings.md)
- API Reference > Users [Get authenticated user](https://learning.postman.com/api-docs/api-reference/users/get-authenticated-user.md)
- API Reference > Users [Get all team users](https://learning.postman.com/api-docs/api-reference/users/get-team-users.md)
- API Reference > Users [Get a team user](https://learning.postman.com/api-docs/api-reference/users/get-team-user.md)
- API Reference > Webhooks [Create a webhook](https://learning.postman.com/api-docs/api-reference/webhooks/create-webhook.md)
- API Reference > Workspaces [Manage Partner Workspace invites](https://learning.postman.com/api-docs/api-reference/workspaces/manage-partner-workspace-invites.md)
- API Reference > Workspaces [Get all workspaces](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspaces.md)
- API Reference > Workspaces [Create a workspace](https://learning.postman.com/api-docs/api-reference/workspaces/create-workspace.md)
- API Reference > Workspaces [Get all roles](https://learning.postman.com/api-docs/api-reference/workspaces/get-all-workspace-roles.md)
- API Reference > Workspaces [Get a workspace](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspace.md)
- API Reference > Workspaces [Update a workspace](https://learning.postman.com/api-docs/api-reference/workspaces/update-workspace.md)
- API Reference > Workspaces [Delete a workspace](https://learning.postman.com/api-docs/api-reference/workspaces/delete-workspace.md)
- API Reference > Workspaces [Get a workspace's activity feed](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspace-activity-feed.md)
- API Reference > Workspaces [Transfer element to a workspace](https://learning.postman.com/api-docs/api-reference/workspaces/transfer-workspace-element.md)
- API Reference > Workspaces [Get global variables](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspace-global-variables.md)
- API Reference > Workspaces [Update global variables](https://learning.postman.com/api-docs/api-reference/workspaces/update-workspace-global-variables.md)
- API Reference > Workspaces [Get a workspace's roles](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspace-roles.md)
- API Reference > Workspaces [Update workspace roles](https://learning.postman.com/api-docs/api-reference/workspaces/update-workspace-roles.md)
- API Reference > Workspaces [Transfer workspace to a team](https://learning.postman.com/api-docs/api-reference/workspaces/transfer-workspace-to-team.md)
- API Reference > Workspaces [Get all workspace updates](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspace-updates.md)
- API Reference > Workspaces [Create a workspace update](https://learning.postman.com/api-docs/api-reference/workspaces/create-workspace-update.md)
- API Reference > Workspaces [Get a workspace update](https://learning.postman.com/api-docs/api-reference/workspaces/get-workspace-update.md)
- API Reference > Workspaces [Delete a workspace update](https://learning.postman.com/api-docs/api-reference/workspaces/delete-workspace-update.md)
- API Reference > Workspaces [Update a workspace update](https://learning.postman.com/api-docs/api-reference/workspaces/patch-workspace-update.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://learning.postman.com/api-docs/api-reference/openapi.json)
- [OpenAPI YAML](https://learning.postman.com/api-docs/api-reference/openapi.yaml)