Retrieve custom environments

APIs & SDKs

GEThttps://api.vercel.com/v9/projects/{idOrName}/custom-environments

Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.

https://api.vercel.com/v9/projects/{idOrName}/custom-environments

const response = await fetch('https://api.vercel.com/v9/projects/idOrName/custom-environments?gitBranch=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "accountLimit": {
    "total": "123"
  },
  "environments": [
    {
      "branchMatcher": {
        "pattern": "string",
        "type": "endsWith"
      },
      "createdAt": "123",
      "currentDeploymentAliases": [],
      "description": "string",
      "domains": [
        {
          "apexName": "Example Name",
          "createdAt": "123",
          "customEnvironmentId": "example_id",
          "gitBranch": "string",
          "name": "Example Name",
          "projectId": "example_id",
          "redirect": "string",
          "redirectStatusCode": "301",
          "updatedAt": "123",
          "verification": [
            {
              "domain": "string",
              "reason": "Customer requested refund",
              "type": "string",
              "value": "string"
            }
          ],
          "verified": "false"
        }
      ],
      "id": "icfg_1234567890",
      "slug": "string",
      "type": "development",
      "updatedAt": "123"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired

The unique project identifier or the project name

Query parameters

gitBranchstringOptional

Fetch custom environments for a specific git branch

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

accountLimitobjectRequired

The maximum number of custom environments allowed either by the team's plan type or a custom override.

environmentsarrayRequired

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: Retrieve custom environments (/docs/rest-api/environment/retrieve-custom-environments)

From the Vercel docs graph (built 2026-10-08T05:38:39.548Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Retrieve a custom environment — GET /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId} — Retrieve a custom environment for the project. M
Create a custom environment for the current project. — POST /v9/projects/{idOrName}/custom-environments — Creates a custom environment for the current project. Cannot be named
Remove a custom environment — DELETE /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId} — Remove a custom environment for the project.
Update a custom environment — PATCH /v9/projects/{idOrName}/custom-environments/{environmentSlugOrId} — Update a custom environment for the project. M
Retrieve the environment variables of a project by id or name — GET /v10/projects/{idOrName}/env — Retrieve the environment variables for a given project by passing either the project

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v9/projects/{idOrName}/custom-environments

const response = await fetch('https://api.vercel.com/v9/projects/idOrName/custom-environments?gitBranch=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "accountLimit": {
    "total": "123"
  },
  "environments": [
    {
      "branchMatcher": {
        "pattern": "string",
        "type": "endsWith"
      },
      "createdAt": "123",
      "currentDeploymentAliases": [],
      "description": "string",
      "domains": [
        {
          "apexName": "Example Name",
          "createdAt": "123",
          "customEnvironmentId": "example_id",
          "gitBranch": "string",
          "name": "Example Name",
          "projectId": "example_id",
          "redirect": "string",
          "redirectStatusCode": "301",
          "updatedAt": "123",
          "verification": [
            {
              "domain": "string",
              "reason": "Customer requested refund",
              "type": "string",
              "value": "string"
            }
          ],
          "verified": "false"
        }
      ],
      "id": "icfg_1234567890",
      "slug": "string",
      "type": "development",
      "updatedAt": "123"
    }
  ]
}

OpenAPI Specification