Sign in

v14

OpenAPI 3.0.32026-08-04377889.4 MB
projects

Retrieve the environment variables of a project by id or name

Retrieve the environment variables for a given project by passing either the project id or name in the URL.

get/v10/projects/{idOrName}/env

Path parameters

idOrNamestring required

The unique project identifier or the project name

Example:prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA

The unique project identifier or the project name

Query parameters

gitBranchstring

If defined, the git branch of the environment variable to filter the results (must have target=preview)

Example:feature-1

If defined, the git branch of the environment variable to filter the results (must have target=preview)

decrypt'true' | 'false'

If true, the environment variable value will be decrypted

Example:true

If true, the environment variable value will be decrypted

sourcestring

The source that is calling the endpoint.

Example:vercel-cli:pull

The source that is calling the endpoint.

customEnvironmentIdstring

The unique custom environment identifier within the project

Example:env_123abc4567

The unique custom environment identifier within the project

customEnvironmentSlugstring

The custom environment slug (name) within the project

Example:my-custom-env

The custom environment slug (name) within the project

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

The list of environment variables for the given project

OR
OR

Example response

{
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}