List a program's prizes

GET

/programs/{id}/prizes

The prize ladder in ordinal order. A ladder is at most three thresholds with at most three interchangeable options each, and the holder redeems ONE option per threshold — which is why several rows can share a threshold. Not paginated: the whole ladder is always one response.

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

List a program's prizes

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

  

"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"

  

  

}

  

]

}

GET

/programs/{id}/prizes

Samples

Powered by VitePress OpenAPI