Read Variables (Folder)

The Read Variables (Folder) endpoint lists reusable variables scoped to your organization's global knowledge base or to a specific template folder. These are standalone variables you manage independently of any one template, for reuse across many templates (for example a company address or a standard clause).

When to use it

Use this endpoint to build a variable library browser, or to look up a variable's id before updating it with Update Variable by ID or deleting it with Delete Variables (by IDs).

Example request

curl "https://api.turbodocx.com/Variable?isGlobal=true&limit=25&offset=0&showTags=true" \
  -H "Authorization: Bearer $TURBODOCX_API_KEY" \
  -H "x-rapiddocx-org-id: $TURBODOCX_ORG_ID" \
  -H "Accept: application/json"

Optionally pass isGlobal=true (your org-wide knowledge base) or templateFolderId=<folder id> (a specific folder) to scope the list; at most one may be set, and passing both is rejected. Omit both to list across your accessible scope. limit defaults to 6, offset to 0, and query filters by name.

Example response

{
  "data": {
    "results": [
      {
        "id": "e4f5a6b7-8c9d-4e0f-a1b2-3c4d5e6f7a8b",
        "variableMapId": "e4f5a6b7-8c9d-4e0f-a1b2-3c4d5e6f7a8b",
        "name": "Company Address",
        "placeholder": "{CompanyAddress}",
        "description": "Standard mailing address block",
        "mimeType": "text",
        "text": "123 Main St, Suite 400, Austin, TX 78701",
        "isGlobal": true,
        "templateFolderId": null,
        "allowRichTextInjection": false,
        "createdBy": "f5e6d7c8-9a0b-4c1d-2e3f-4a5b6c7d8e9f",
        "updatedOn": "2026-05-01T14:22:10.000Z"
      }
    ],
    "totalRecords": 1
  }
}

An image variable's text holds a data: URI rather than plain text.

Common errors

Status	When	Response body
401	Missing or invalid API key/token, or the organization cannot be resolved	Empty (status only)
400	Both isGlobal and templateFolderId are set, or a query parameter fails validation	{ "message", "type": "ValidationError", "data": { "errors": [...] } }

Related endpoints

• Update Variable by ID to change a variable found here

• Delete Variables (by IDs) to remove variables in bulk

• Get Template by ID to see how folder and global variables merge into a template

  GET

  /Variable