Skip to main content
GET
List secrets for an environment

Authorizations

x-brimble-key
string
header
required

API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.

Path Parameters

projectId
string
required

ID of the project.

Pattern: ^[a-fA-F0-9]{24}$
environment
enum<string>
required

PREVIEW for secrets used by preview deployments; any other value means production. Use the path without this segment for production.

Available options:
PRODUCTION,
PREVIEW

Query Parameters

includeEnvironment
boolean

Also return variables shared by the project's environment, marked with source: environment.

limit
string

Accepted for compatibility. Every secret is returned.

page
string

Accepted for compatibility. Every secret is returned.

filterBy
string

Accepted for compatibility. Secrets are always sorted by name.

Response

Env fetched successfully

message
string
required

Human-readable result of the request.

Example:

"Env fetched successfully"

data
object
required

The result of the request.

Last modified on October 11, 2026