Get template variables for a type

Returns the list of supported variable tokens (with sample values) usable in the header/body/footer/signature content for one template type.

Auth: Both — authentication + an email-template feature check. company_id scoped by an ownership check validation rule. (Same scope rule for both roles; a partner can address any descendant company, an account only itself and its descendants.)

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
company_idintegerYesMust be an existing account inside your own account tree.
typestringYesMust be a valid EmailTemplateType value.

Response{ data. } envelope, with nested status + data array of EmailVariableRegistry definitions.

  • status (string) — success.
  • data (array) — each item:
  • name (string) — display name, e.g. Recipient Name.
  • token (string) — bracketed token to insert, e.g. [recipientName].
  • description (string) — what the token resolves to.
  • sample (string) — sample value used in preview/test.
  • scope (string) — token scope, e.g. recipient, review, location, account, global.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json