Get one card

GET

/cards/{id}

One holder's card, with the program it was minted from and the locations it works at (derived from the PROGRAM's scope — a card carries no location of its own). installed_at is the field to check before offering an edit: once it is set, the pass is on a device and the holder fields are frozen.

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 card

Content-Type

application/json

{

  

"id": "cin_docsfixture0001",

  

"program_id": "prg_docsfixture0001",

  

"program_name": "Coffee Card",

  

"program_type": "standard",

  

"external_ref": "EMP-00417",

  

"holder_name": "Ada Lovelace",

  

"holder_email": "ada@docsfixture.invalid",

  

"status": "active",

  

"stamps_count": 4,

  

"current_value": 4,

  

"expires_at": "2026-10-04T10:15:00.000Z",

  

"installed_at": "2026-09-04T10:15:00.000Z",

  

"created_at": "2026-08-05T10:15:00.000Z",

  

"all_locations": true,

  

"locations": [

  

  

{

  

  

  

"id": "loc_docsfixture0001",

  

  

  

"name": "Via Roma 1"

  

  

}

  

]

}

GET

/cards/{id}

Samples

Powered by VitePress OpenAPI