Skip to main content
GET
/
api
/
v2
/
public
/
env
/
definitions
curl -X GET "https://app.refold.ai/api/v2/public/env/definitions?scope=org" \
  -H "x-api-key: YOUR_API_KEY"

{
  "docs": [
    {
      "_id": "6a159a9741e63efd0833773f",
      "org_id": "6500a1b2c3d4e5f6a7b8c9d0",
      "name": "API_BASE_URL",
      "description": "Base URL for callbacks",
      "scope": "org",
      "var_format": "string",
      "encrypted": false,
      "createdAt": "2026-05-26T13:05:27.782Z",
      "updatedAt": "2026-05-26T13:05:27.782Z"
    }
  ],
  "totalDocs": 24,
  "limit": 10,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true
}
List the environment-variable definitions for your organization, paginated. A definition describes a variable’s name, scope, format, and whether it’s encrypted — the actual values are managed separately (see Set Variable Value).

​
Authentication

Definitions are org-level, so this endpoint uses API-key auth.
​
x-api-key
string
required
Your Refold API key.

​
Query Parameters

​
scope
string
Filter by scope: org, linked_account, or workflow.
​
var_format
string
Filter by format, e.g. string, number, url.
​
name
string
Filter by name (regex).
​
page
integer
default:"1"
Page number.
​
limit
integer
default:"10"
Page size.

​
Response

Returns a paginated envelope of definitions.
​
docs
array
Definition objects.
​
totalDocs
integer
Total definitions.
​
page
integer
Current page.
​
hasNextPage
boolean
Whether another page follows.
{
  "docs": [
    {
      "_id": "6a159a9741e63efd0833773f",
      "org_id": "6500a1b2c3d4e5f6a7b8c9d0",
      "name": "API_BASE_URL",
      "description": "Base URL for callbacks",
      "scope": "org",
      "var_format": "string",
      "encrypted": false,
      "createdAt": "2026-05-26T13:05:27.782Z",
      "updatedAt": "2026-05-26T13:05:27.782Z"
    }
  ],
  "totalDocs": 24,
  "limit": 10,
  "page": 1,
  "totalPages": 3,
  "hasNextPage": true
}

curl -X GET "https://app.refold.ai/api/v2/public/env/definitions?scope=org" \
  -H "x-api-key: YOUR_API_KEY"