API reference

Get a template

One template and the variables it names.

Open in Claude Open in ChatGPT .md

GET/v1/templates/{id}

One template and the variables it names.

Needs a key with the messages:read scope. Keys and scopes

Path parameters

idstringrequired
The template’s id.
Starts with tpl_.

Example

GET/v1/templates/tpl_1Hq2LxW9cVbN3mKpRtYs0aGet a template →

curl "https://usebluebot.com/api/v1/templates/tpl_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: The template.

idstringrequired
A tpl_ id.
Starts with tpl_.
object"template"required
namestringrequired
Its name, unique among your templates.
bodystringrequired
The text, with {{variables}} and {{variable|fallback}}.
variablesarray of stringsrequired
The variables the text names, in order, once each.
created_attimestamprequired
When it was made.
updated_attimestamprequired
When it last changed.

Response200

{
  "id": "tpl_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "template",
  "name": "Showing reminder",
  "body": "Hi {{first_name|there}}, see you at {{showing}} tomorrow.",
  "variables": [
    "first_name",
    "showing"
  ],
  "created_at": "2026-11-10T16:00:00.000Z",
  "updated_at": "2026-11-10T16:00:00.000Z"
}

Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

Code	Status	What it means
`unauthorized`	401	The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.
`insufficient_scope`	403	The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.
`rate_limited`	429	Too many requests. A key may make 120 requests a minute. The `RateLimit` header says how many are left, and `Retry-After` how long to wait.
`internal`	500	Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.
`not_found`	404	There is no such thing on this account. Ids are prefixed by kind, so a message id starts with `msg_`.

Try it

Call this operation from the page with your own key. The key stays in this tab and is forgotten when you leave.