ZapSMTP / Docs / VariablesResponse
List variables
GET/v1/variables
The variable catalogue: every variable the account’s templates can use, with where each is used. System variables first, then global ones, then template variables, each sorted by name.
Requires a full-access key.
kind is system (filled by ZapSMTP), global (set for the account, written {{global.key}}) or template (a template’s own).
A global variable that templates use but that has no value yet is listed without value; sends with those templates fail until you set it.
A template variable lists in types every type its templates declare, and per template its type, required, default and unused (declared, but the source no longer names it).
Errors
restricted_api_keyHTTP 403
curl 'https://zapsmtp.xyz/v1/variables' \
-H "Authorization: Bearer $ZAP_API_KEY"const res = await fetch('https://zapsmtp.xyz/v1/variables', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.ZAP_API_KEY}`,
},
});
// 204 No Content (e.g. a delete) has no body
const data = res.status === 204 ? null : await res.json();
if (!res.ok) throw new Error(`${data.name}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://zapsmtp.xyz/v1/variables",
headers={"Authorization": f"Bearer {os.environ['ZAP_API_KEY']}"},
timeout=30,
)
res.raise_for_status()
print(res.json() if res.status_code != 204 else "deleted")<?php
$ch = curl_init('https://zapsmtp.xyz/v1/variables');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ZAP_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 400) {
throw new RuntimeException($data['message']);
}
print_r($data);package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(
"GET",
"https://zapsmtp.xyz/v1/variables",
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("ZAP_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}require 'net/http'
require 'json'
uri = URI('https://zapsmtp.xyz/v1/variables')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = "Bearer #{ENV.fetch('ZAP_API_KEY')}"
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, (JSON.parse(res.body) unless res.body.to_s.empty?)import java.net.URI;
import java.net.http.*;
public class ZapRequest {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create("https://zapsmtp.xyz/v1/variables"))
.header("Authorization", "Bearer " + System.getenv("ZAP_API_KEY"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://zapsmtp.xyz/v1/variables");
request.Headers.Authorization = new AuthenticationHeaderValue(
"Bearer", Environment.GetEnvironmentVariable("ZAP_API_KEY"));
var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");Set
ZAP_API_KEY in your environment.Response 200 OK
{
"object": "list",
"has_more": false,
"data": [
{
"object": "variable",
"name": "zap:unsubscribe_url",
"kind": "system",
"type": "url",
"description": "The recipient's one-click unsubscribe link (also adds List-Unsubscribe).",
"templates": []
},
{
"object": "variable",
"name": "global.company_name",
"kind": "global",
"type": "string",
"key": "company_name",
"value": "Acme Inc.",
"description": "Legal name for footers",
"updated_at": "2026-10-25T14:20:00Z",
"templates": [
{
"id": "019a1f23-7f80-7192-8b3c-4d5e6f7a8b9c",
"name": "Receipt"
}
]
},
{
"object": "variable",
"name": "global.support_url",
"kind": "global",
"type": "string",
"key": "support_url",
"templates": [
{
"id": "019a1f23-7f80-7192-8b3c-4d5e6f7a8b9c",
"name": "Receipt"
}
]
},
{
"object": "variable",
"name": "coupon",
"kind": "template",
"types": [
"object"
],
"templates": [
{
"id": "019a1f23-7f80-7192-8b3c-4d5e6f7a8b9c",
"name": "Receipt",
"type": "object"
}
]
},
{
"object": "variable",
"name": "order_id",
"kind": "template",
"types": [
"string"
],
"description": "Order number shown to the customer",
"templates": [
{
"id": "019a1f23-7f80-7192-8b3c-4d5e6f7a8b9c",
"name": "Receipt",
"type": "string",
"required": true
}
]
}
]
}