Docs
/
/

Variables Management API reference

Complete reference documentation for the Variables resource.

Variables

#

Variables are used to store shared attributes for your workflows and templates at the environment level.

List variables

#

Returns a paginated list of variables for a given environment.

Endpoint

GET/v1/variables

Query parameters

environment
string

The environment slug.

branch
string

The slug of a branch to use. This option can only be used when environment is "development".

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

limit
integer

The number of entries to fetch per-page.

Returns

PaginatedVariableResponse

A paginated list of Variable. Contains a list of entries and page information.

entries

A list of entries.

description
string

The description of the variable.

inserted_at
string(date-time)
Required

The timestamp of when the variable was created.

key
string
Required

The key of the variable.

type
enum(string)
Required

The type of the variable.

publicsecret
updated_at
string(date-time)
Required

The timestamp of when the variable was last updated.

value
string
Required

The value of the variable.

page_info

The information about a paginated result.

after
string

The cursor to fetch entries after. Will only be present if there are more entries to fetch.

before
string

The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.

page_size
integer

The number of entries to fetch per-page.

Variable

#

An environment variable object.

Attributes

description
string

The description of the variable.

inserted_at
string(date-time)

The timestamp of when the variable was created.

key
string

The key of the variable.

type
enum(string)

The type of the variable.

publicsecret
updated_at
string(date-time)

The timestamp of when the variable was last updated.

value
string

The value of the variable.

New chat