Onboardly
Get started

Reference templates

List your own reference templates, to choose a `template_id` for Add a reference or Update a reference.

GET/api/v1/reference-templates#

List your own reference templates, so you can pick a `template_id` to pin on Add a reference / Update a reference.

Headers

X-Api-Keyonb_live_<key_id>_<secret>required
Your issued Partner API key — see Authentication.

Status codes

2002xx
Your templates, newest-updated first.
4014xx
Missing, malformed, unknown or revoked key. Every authentication failure looks the same — see Authentication.
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5005xx
The service is temporarily unavailable, or the read failed.
This resource is temporarily unavailable. Try again shortly.Could not list reference templates. Try again shortly.
  • Discovery only — this route never sends anything. Pass an id from this list as template_id on Add a reference or Update a reference to pin it to that specific request.
  • is_default marks the template a send falls back to when no template_id is pinned on the request — see How reference emails are sent.
  • Projection is deliberately narrow: no block content, no timestamps. This is a picker list, not the template builder.
cURL
curl \
  "https://rca-onboardly.com/api/v1/reference-templates" \
  -H "X-Api-Key: $ONB_KEY"
200 · Response
{
  "templates": [
    {
      "id": "2c6b1e4a-7f3d-4a9e-8b5c-6d1f4a3e9c72",
      "name": "Standard reference request",
      "is_default": true
    },
    {
      "id": "9d4a7c1e-2b6f-4e3a-9c8d-5f1a2b3c4d60",
      "name": "Character reference request",
      "is_default": false
    }
  ]
}

See How reference emails are sent for where a pinned template sits in the send order.

PreviousUpdate a referenceNextHow reference emails are sent