highreel
Developers

The API

Your server asks Highreel for each person's link: everyone in a Highreel, or one person by the id in your sheet or their email. Read only, and never from a web page.

4 min read

Keys

Make a key in Highreel under Integrations (My developer › Make an API key). It's shown once: copy it into your server's secrets, never into a web page or an app people download. A key reads every published Highreel of the account that made it, and nothing else. When the account makes Highreels for more than one business, a key is made for one of them (or for all): a key for one business answers as if the others' Highreels weren't there. An account has up to 10 live keys; revoke one from the same place and it stops working at once (revoked keys stay listed for 30 days).

Send it with every request:

Terminal
curl https://highreel.app/api/v1/highreels \
  -H "Authorization: Bearer $HIGHREEL_API_KEY"

The API sends no CORS headers, on purpose: a browser on your site can't read its answers, so a key pasted into a web page fails at once instead of leaking quietly.

Your Highreels

GET /api/v1/highreels lists the account's published Highreels for customers, newest first. business is the name on the Highreel's Brand tab, since one account can make Highreels for several businesses; people counts the people with a link.

JSON
{
  "data": [
    {
      "id": "0b8e4f3c-5d1a-4c2e-9f7b-2a6d8c1e4b90",
      "name": "Members 2026",
      "business": "Your studio",
      "year": 2026,
      "people": 1245,
      "published_at": "2026-12-01T09:30:00.000Z"
    }
  ],
  "next": null
}

Everyone in a Highreel

GET /api/v1/highreels/:id/people lists a Highreel's people in the order of its sheet, 500 a page, or up to 1,000 with limit. Each answer's next is the after for the page that follows, and null on the last page.

Terminal
curl "https://highreel.app/api/v1/highreels/0b8e4f3c-5d1a-4c2e-9f7b-2a6d8c1e4b90/people?limit=1000" \
  -H "Authorization: Bearer $HIGHREEL_API_KEY"

Each person:

JSON
{
  "id": "M-1042",
  "first_name": "Ana",
  "email": "ana@example.com",
  "link": "https://highreel.app/r/Ab12Cd34Ef56",
  "banner": "https://highreel.app/r/Ab12Cd34Ef56/banner",
  "image": "https://highreel.app/api/r/Ab12Cd34Ef56/og.png",
  "look": {
    "background": "#1F3BFF",
    "text": "#FFFFFF",
    "accent": "#FFE45C",
    "accent_text": "#111111"
  }
}
FieldWhat it is
idThe value in the id column of the sheet the Highreel was made from, so you find people by your own ids.
first_name, emailAs in the sheet; null where the sheet had none.
linkTheir Highreel: what the banner and the player take.
bannerTheir banner page, for a plain iframe.
imageTheir link preview, 1,200 × 630, with their first name and two of their numbers: for an email or an app that wants a picture.
lookTheir cover's colors: background, text, and the button's accent and accent_text, for an app drawing its own banner in the Highreel's look.

Only people with a link are listed. Never a phone number, the sheet's other cells, or anything about who opened what.

In Node, every person in a Highreel, page by page:

JavaScript
const KEY = process.env.HIGHREEL_API_KEY

async function everyone(highreelId) {
  const people = []
  let after = null
  do {
    const url = new URL(`https://highreel.app/api/v1/highreels/${highreelId}/people`)
    url.searchParams.set('limit', '1000')
    if (after) url.searchParams.set('after', after)
    const res = await fetch(url, { headers: { Authorization: `Bearer ${KEY}` } })
    const page = await res.json()
    if (!res.ok) throw new Error(page.error.message)
    people.push(...page.data)
    after = page.next
  } while (after)
  return people
}

One person

GET /api/v1/people takes id (the sheet's id) or email (any case), and optionally highreel to look in one Highreel only. It answers with up to 50 people, each with the Highreel they're in: someone in two Highreels, or siblings who share a parent's address, comes back more than once. Use it when a member's page renders, then keep the link.

Terminal
curl "https://highreel.app/api/v1/people?email=ana%40example.com" \
  -H "Authorization: Bearer $HIGHREEL_API_KEY"
JSON
{
  "data": [
    {
      "id": "M-1042",
      "first_name": "Ana",
      "email": "ana@example.com",
      "link": "https://highreel.app/r/Ab12Cd34Ef56",
      "banner": "https://highreel.app/r/Ab12Cd34Ef56/banner",
      "image": "https://highreel.app/api/r/Ab12Cd34Ef56/og.png",
      "look": { "background": "#1F3BFF", "text": "#FFFFFF", "accent": "#FFE45C", "accent_text": "#111111" },
      "highreel": { "id": "0b8e4f3c-5d1a-4c2e-9f7b-2a6d8c1e4b90", "name": "Members 2026", "business": "Your studio", "year": 2026 }
    }
  ],
  "next": null
}

Whoever you look up is who your site shows the Highreel to. Look someone up by an email only once your site knows the address is theirs: they signed in with it, or clicked a link you sent to it. An address someone only typed into a form isn't proof, and would let them see another person's Highreel.

Where your platform keeps the id from the sheet, look people up by id rather than email: the address of a request stays in server logs for a few days, yours and ours, and an id says less about someone than their email does.

Fetch once, keep it

Once a Highreel is published its list is set: nobody is added or removed and every link stays the same. So fetch the links once, when the Highreel is published, and keep each with its member in your own database. A lookup per page view works too, but it spends your requests a minute and makes every page wait on Highreel.

Errors and limits

Answers are JSON, never cached. Each key may make 120 requests a minute; past that, a 429 with Retry-After in seconds. An error looks like this:

JSON
{ "error": { "code": "unauthorized", "message": "This API key doesn't work: it's mistyped or was revoked." } }
StatuscodeWhen
401unauthorizedNo key, a mistyped key, or a revoked one.
404not_foundNo such Highreel in this account, or an address the API doesn't have.
405method_not_allowedAnything but a GET request: the API only reads.
422invalid_requestA parameter that doesn't fit: limit outside 1 to 1,000, both id and email, or neither. The message names it.
429rate_limitedOver 120 requests a minute with this key. Wait for Retry-After.
500server_errorSomething went wrong on Highreel's side. Try again in a moment.

Questions

Can I call the API from the browser?

No, on purpose. Anyone who has a key can read every link in the account, so it belongs on a server. The API sends no CORS headers, so a browser on your site can't read its answers.

Do links change when the business fixes a typo?

No. Correcting a number or a line in a published Highreel keeps every link the same. A link only stops working if the business deletes the Highreel.

Can the API change anything?

No. It only reads: published Highreels and their people. Publishing, editing and sending stay in Highreel itself.

Keep reading

Your customers had a great year. Show them.

No account needed · from $99 per campaign