GET/v1/message-placeholders

List the placeholders a message template can use

The placeholder vocabulary a message or document template may draw on — the tokens that resolve against a record when a template is rendered, and what each one stands for. Read it before writing a template, so a token that resolves to nothing is never sent to a merchant. Read-only for everyone: growing this list is a schema change, not a write.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

bodyquery · nulloptional

paramsquery · objectoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "description": "string",
      "group": "string",
      "label": "string",
      "name": "string"
    }
  ]
}

dataarray<>required

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired