List template variables

GET/v1/sequences/template/variables

Lists the variables a sequence template may use: the first and last name, the contact’s and its first account’s fields of a type a message can print, and the sender’s name and email. Use an entry’s ref in a send step’s subject or body. A variable needs a fallback for contacts missing the value: {{ {attr:ad_…} }} is written {{ coalesce({attr:ad_…}, "fallback") }}, and one without a fallback is refused when the draft is saved. Anything else inside {{ }} is refused too.

Required scopes: sequences:read, contacts:read and accounts:read

Rate limit category: Read

ReturnsExpand Collapse

SequenceListTemplateVariablesResponse object { data, object, totalCount }

data: array of object { field, group, label, ref }

field: object { id, valueType }

The field the variable reads; null for built-in variables.

id: string

The ad_ id of the field, as the field-definitions endpoints list it.

valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 12 more

Type of the field.

One of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

"HTML"

group: "contact" or "account" or "sender"

Whose value the variable prints: the enrolled contact, its first account, or the step’s sender.

One of the following:

"contact"

"account"

"sender"

label: string

Name of the variable, as the editor shows it.

ref: string

The variable, e.g. {{ {attr:ad_…} }}. A variable needs a fallback for contacts missing the value: {{ {attr:ad_…} }} is written {{ coalesce({attr:ad_…}, "fallback") }}, and one without a fallback is refused when the draft is saved.

object: "list"

totalCount: number

minimum-9007199254740991

maximum9007199254740991

List template variables

curl https://api.lightfield.app/v1/sequences/template/variables \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY"

{
  "data": [
    {
      "field": {
        "id": "id",
        "valueType": "ADDRESS"
      },
      "group": "contact",
      "label": "label",
      "ref": "ref"
    }
  ],
  "object": "list",
  "totalCount": -9007199254740991
}

Returns Examples

{
  "data": [
    {
      "field": {
        "id": "id",
        "valueType": "ADDRESS"
      },
      "group": "contact",
      "label": "label",
      "ref": "ref"
    }
  ],
  "object": "list",
  "totalCount": -9007199254740991
}