Skip to main content

Get Merge Tags

Retrieve all available merge tags for the workspace, including contact fields, workspace properties, and system tags.

Endpoint​

GET https://api.campaignlark.com/v1/merge-tags

Request​

This endpoint accepts no query parameters or request body.

Sample Request​

GET https://api.campaignlark.com/v1/merge-tags

Response​

Success — 200 OK​

{
  "error": null,
  "data": [
    {
      "tag": "contact.first_name",
      "label": "First Name",
      "category": "contact"
    },
    {
      "tag": "contact.last_name",
      "label": "Last Name",
      "category": "contact"
    },
    {
      "tag": "workspace.company_name",
      "label": "Company Name",
      "category": "workspace"
    },
    {
      "tag": "actions.view_online_url",
      "label": "View Online URL",
      "category": "actions"
    },
    {
      "tag": "actions.unsubscribe_url",
      "label": "Unsubscribe URL",
      "category": "actions"
    },
    {
      "tag": "actions.manage_preferences_url",
      "label": "Manage Preferences URL",
      "category": "actions"
    },
    {
      "tag": "preview_text",
      "label": "Preview Text",
      "category": "system"
    },
    {
      "tag": "misc.server_time",
      "label": "Server Time",
      "category": "system"
    }
  ]
}

Merge Tag Object​

FieldTypeDescription
tagstringThe merge tag string to use in templates (e.g. contact.first_name).
labelstringHuman-readable label for the tag.
categorystringTag category: contact, workspace, actions, or system.

Tag Categories​

  • contact — Tags derived from contact fields (both built-in and custom). Values are per-recipient.
  • workspace — Tags derived from workspace properties. Values are shared across all recipients.
  • actions — System-generated URLs for unsubscribe, view online, and preference management.
  • system — Other system tags like preview text and server time.