Get Lead Variables

List the merge-tag variables available in sequence copy.

GEThttps://api.foxreach.io/api/v1/leads/variables

Requires an API key with the read scope.

Returns the standard lead fields, the custom field keys found on your workspace's leads, and the sending account fields. Use the name as {{name}} in a subject or body. Custom keys are read from every live lead in the workspace.

Response#

dataobject

Show data

standardarray

Lead fields such as firstName, company, email. Each has name, label, example and group.

customarray

One entry per custom field key on your leads.

accountarray

signature, senderName, senderEmail.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`

Rate Limit#

300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Request

cURL

curl -X GET "https://api.foxreach.io/api/v1/leads/variables" \
  -H "X-API-Key: otr_your_key"

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
variables = client.leads.variables()

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const variables = await client.leads.variables();

Response

JSON

{
  "data": {
    "standard": [{ "name": "firstName", "label": "First Name", "example": "John", "group": "standard" }],
    "custom": [{ "name": "plan_tier", "label": "Plan Tier", "example": "", "group": "custom" }],
    "account": [{ "name": "senderName", "label": "Sender Name", "example": "John Doe", "group": "account" }]
  }
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026