Skip to content

Get one program

GET
/programs/{id}

The full template: everything the list returns, plus the prize ladder resolved in order and has_installed_cards — the edit lock. Once a single card minted from this program is installed on a device, the template is frozen and an update returns program_has_installed_cards, so check that flag before offering an edit screen of your own.

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

Get one program

application/json
JSON
{
  
"id": "prg_docsfixture0001",
  
"name": "Coffee Card",
  
"description": "Ten coffees, the eleventh on us.",
  
"category": "bar",
  
"type": "standard",
  
"active": true,
  
"published_at": "2026-09-04T10:15:00.000Z",
  
"suspended_at": null,
  
"total_stamps": 10,
  
"repeat_after_reset": true,
  
"discount_percent": null,
  
"initial_balance_cents": null,
  
"default_expire_after_days": 365,
  
"logo_url": "https://cdn.tesserapp.eu/shops/caffe-docsfixture/logo.png",
  
"access_image_url": null,
  
"brand_color_hex": "#6F4E37",
  
"bg_color_hex": "#FFF8F0",
  
"text_color_hex": "#2B1B12",
  
"icon_key": "mug-hot",
  
"location_scope": "all_locations",
  
"scoped_location_ids": [
  
  
"loc_docsfixture0001"
  
],
  
"created_at": "2026-08-05T10:15:00.000Z",
  
"updated_at": "2026-09-04T10:15:00.000Z",
  
"prizes": [
  
  
{
  
  
  
"id": "prz_docsfixture0001",
  
  
  
"program_id": "prg_docsfixture0001",
  
  
  
"threshold": 10,
  
  
  
"name": "Free coffee",
  
  
  
"description": "One espresso or filter coffee, redeemed at the till.",
  
  
  
"ordinal": 0,
  
  
  
"created_at": "2026-08-05T10:15:00.000Z",
  
  
  
"updated_at": "2026-09-04T10:15:00.000Z"
  
  
}
  
],
  
"has_installed_cards": false
}

Samples

Powered by VitePress OpenAPI

Requires the Business API add-on.