Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a template

GET/templates/{id}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstringrequired

Template id or alias

min length 1
Responses
200

Template by id or alias. Templates have no draft/publish cycle: every save is live, so status is always published. from, reply_to and variables are not supported yet and read as null, null and [].

idstring<uuid>required
namestringrequired
aliasstring | nullrequired
statusstringrequired
Allowed:published
published_atstringrequired
created_atstringrequired
updated_atstringrequired
objectstringrequired
Allowed:template
current_version_idstring<uuid>required
fromnullrequired
subjectstring | nullrequired
reply_tonullrequired
htmlstringrequired
textstring | nullrequired
variablesany[]required

Always empty

has_unpublished_versionsbooleanrequired
Allowed:false
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/templates/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "alias": "string",
  "status": "published",
  "published_at": "string",
  "created_at": "string",
  "updated_at": "string",
  "object": "template",
  "current_version_id": "158beffb-f9de-457f-bbee-873740e72504",
  "from": null,
  "subject": "string",
  "reply_to": null,
  "html": "string",
  "text": "string",
  "variables": [
    null
  ],
  "has_unpublished_versions": false
}

Was this page helpful?