GET
/
v9
/
projects
/
{idOrName}
/
custom-environments
get_/v9/projects/{idOrName}/custom-environments
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.environment.getV9ProjectsIdOrNameCustomEnvironments({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "accountLimit": {
    "total": 123
  },
  "environments": [
    {
      "id": "<string>",
      "slug": "<string>",
      "type": "production",
      "description": "<string>",
      "branchMatcher": {
        "type": "endsWith",
        "pattern": "<string>"
      },
      "domains": [
        {
          "name": "<string>",
          "apexName": "<string>",
          "projectId": "<string>",
          "redirect": "<string>",
          "redirectStatusCode": 307,
          "gitBranch": "<string>",
          "customEnvironmentId": "<string>",
          "updatedAt": 123,
          "createdAt": 123,
          "verified": true,
          "verification": [
            {
              "type": "<string>",
              "domain": "<string>",
              "value": "<string>",
              "reason": "<string>"
            }
          ]
        }
      ],
      "currentDeploymentAliases": [
        "<string>"
      ],
      "createdAt": 123,
      "updatedAt": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The unique project identifier or the project name

Query Parameters

​
gitBranch
string

Fetch custom environments for a specific git branch

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

The response is of type object.