Retrieve the decrypted value of a Shared Environment Variable by id.

APIs & SDKs

GEThttps://api.vercel.com/v1/env/{id}

Retrieve the decrypted value of a Shared Environment Variable by id.

https://api.vercel.com/v1/env/{id}

const response = await fetch('https://api.vercel.com/v1/env/id?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

{
  "applyToAllCustomEnvironments": "false",
  "comment": "string",
  "created": "2021-02-10T13:11:49.180Z",
  "createdAt": "1609492210000",
  "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "customEnvironmentIds": [],
  "decrypted": "false",
  "deletedAt": "1609492210000",
  "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
  "key": "my-api-key",
  "lastEditedByDisplayName": "Example Name",
  "lastEditedByPrincipal": {
    "avatar": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "type": "user",
    "username": "string"
  },
  "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
  "projectId": [],
  "target": [],
  "type": "encrypted",
  "updatedAt": "1609492210000",
  "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "value": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idstringRequired

The unique ID for the Shared Environment Variable to get the decrypted value.

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

applyToAllCustomEnvironmentsbooleanOptional

whether or not this env varible applies to custom environments

commentstringOptional

A user provided comment that describes what this Shared Env Var is for.

createdstringOptional

The date when the Shared Env Var was created.

createdAtnumberOptional

Timestamp for when the Shared Env Var was created.

createdBystringOptional

The unique identifier of the user who created the Shared Env Var.

customEnvironmentIdsarrayOptional

The custom environment IDs that this Shared Env Var is scoped to.

decryptedbooleanOptional

whether or not this env variable is decrypted

deletedAtnumberOptional

Timestamp for when the Shared Env Var was (soft) deleted.

deletedBystringOptional

The unique identifier of the user who deleted the Shared Env Var.

idstringOptional

The unique identifier of the Shared Env Var.

keystringOptional

The name of the Shared Env Var.

lastEditedByDisplayNamestringOptional

The last editor full name or username.

lastEditedByPrincipalobjectOptional2 variants

ownerIdstringOptional

The unique identifier of the owner (team) the Shared Env Var was created for.

projectIdarrayOptional

The unique identifiers of the projects which the Shared Env Var is linked to.

targetarrayOptional

environments this env variable targets

typestringOptional

The type of this cosmos doc instance, if blank, assume secret.

updatedAtnumberOptional

Timestamp for when the Shared Env Var was last updated.

updatedBystringOptional

The unique identifier of the user who last updated the Shared Env Var.

valuestringOptional

The value of the Shared Env Var.

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 the decrypted value of a Shared Environment Variable by id. (/docs/rest-api/environment/retrieve-the-decrypted-value-of-a-shared-environment-variable-by-id)

From the Vercel docs graph (built 2026-10-13T05:35:52.211Z), 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

Lists all Shared Environment Variables for a team — GET /v1/env — Lists all Shared Environment Variables for a team, taking into account optional filters.
Retrieve the decrypted value of an environment variable of a project by id — GET /v1/projects/{idOrName}/env/{id} — Retrieve the environment variable for a given project.
Create one or more shared environment variables — POST /v1/env — Creates shared environment variable\(s\) for a team.
Updates one or more shared environment variables — PATCH /v1/env — Updates a given Shared Environment Variable for a Team.
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/v1/env/{id}

const response = await fetch('https://api.vercel.com/v1/env/id?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

{
  "applyToAllCustomEnvironments": "false",
  "comment": "string",
  "created": "2021-02-10T13:11:49.180Z",
  "createdAt": "1609492210000",
  "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "customEnvironmentIds": [],
  "decrypted": "false",
  "deletedAt": "1609492210000",
  "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
  "key": "my-api-key",
  "lastEditedByDisplayName": "Example Name",
  "lastEditedByPrincipal": {
    "avatar": "string",
    "id": "icfg_1234567890",
    "name": "Example Name",
    "type": "user",
    "username": "string"
  },
  "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
  "projectId": [],
  "target": [],
  "type": "encrypted",
  "updatedAt": "1609492210000",
  "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "value": "string"
}

OpenAPI Specification