/api/system/variables

Lists all personalization variables (%Variable%) that can be used in mails, SMS and content texts, with the groups they belong to. Aliases and descriptions come in the requested language; an alias that does not exist in that language falls back to the default (German) form, which resolves as well.

Parameters

(string) language of aliases, descriptions and group labels (de, en, es, fr, sl); default: the request's locale
(string) optionally return only the group with this key (see VariableGroup.key) and its variables; default: all groups🔗 variablegroup
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized.

Response Types

VariableGroup ยท Variable

VariableGroup (v1) docs

A group of personalization variables sharing the same context (customer, item, order, ...). Groups are listed in the recommended display order.

Fields (3)
#FieldTypeDescriptionLinks
0keystringgroup key, referenced by Variable.group, e.g. customer⬆ group🔗 variablegroup
1labelstringhuman-readable group name in the requested language
2needs_customerbooltrue if the variables only resolve in the context of an addressed customer

Data (1 record)

keylabelneeds_customer
article →variables ⬆Articlefalse

Variable (v1) docs

A personalization variable: written as %alias% into a mail, SMS or content text, it is replaced by data of the addressed customer, an item, a date or a link when the text is used. Some aliases carry an id or amount argument, e.g. Artikel..Name - see the group's id_label.

Fields (4)
#FieldTypeDescriptionLinks
0keystringlanguage-independent key of the variable, e.g. customer.firstname
1groupstringkey of the variable group (see VariableGroup) this variable belongs to, e.g. customer⬆ group🔗 variablegroup
2aliasstringthe name to write between the percent signs, in the requested language, e.g. Vorname; parts mark an argument to fill in
3descriptionstringwhat the variable is replaced with, in the requested language

Data (8 records)

keygroupaliasdescription
article.htmlInfoarticle →variables ⬆Article.HtmlArticle.<Number>.Html
article.iconarticle →variables ⬆Article.IconArticle.<Number>.Icon
article.imagearticle →variables ⬆Article.ImageArticle.<Number>.Image
article.keywordsarticle →variables ⬆Article.KeywordsArticle.<Number>.Keywords
article.shortnamearticle →variables ⬆Article.ShortnameArticle.<Number>.Shortname
article.infotxtarticle →variables ⬆Article.Textarticle.<Number>.Text
article.urlarticle →variables ⬆Article.UrlArticle.<Number>.Url
article.wiki2htmlarticle →variables ⬆Article.Wiki2HTMLArticle.<Number>.Wiki2HTML