Skip to content

The public enrollment deep link and its QR

GET
/programs/{id}/enrollment-qr

Returns the deep link string and an inline SVG, so embedding it in your own portal — or printing a poster — is one call.

Authorizations

ApiKeyBearer

A shop-scoped API key created in the dashboard and shown exactly once. An MCP tmk_ key presented here returns a 401 that names the mistake.

Type
HTTP (bearer)

Parameters

Path Parameters

id*

An opaque id. The API never promises an id format.

Type
string
Required

Responses

The public enrollment deep link and its QR

application/json
JSON
{
  
"deep_link": "tesserapp://program/prg_docsfixture0001/enroll",
  
"qr_svg": "<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 25 25" shape-rendering="crispEdges">…</svg>"
}

Samples

Powered by VitePress OpenAPI

Requires the Business API add-on.