List available message tokens

Returns all tokens that can be used inside a Message Template's content field. The list includes:

  • System tokens — built-in reserved words (e.g. candidate_name, job_title, scheduler_url) that are resolved at send time.
  • Custom tokens — company-defined tokens created by your team.

Use the id of a token as the Handlebars key in template content: {{candidate_name}}, {{job_title}}, etc.

Filtering: Use display_name for a case-insensitive partial-match filter to quickly find the token you need.

Query Params
string
required

The API key provided for your application.

string

Case-insensitive partial-match filter on the token display name (e.g. candidate returns all candidate-related tokens).

Responses

401

Missing, invalid, or inactive API key.

500

Internal server error; the response may include an exception message.

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