Get a template

curl https://api.tapace.lk/v1/templates/tmpl_Q4vN8xT2mLr7KpZs3Wd1 \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "template",
  "id": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "type": "generic",
  "name": "Gold membership",
  "revision": 3,
  "archived": false,
  "requiredFields": ["memberName"],
  "createdAt": "2026-10-01T09:00:00.000Z",
  "updatedAt": "2026-10-12T15:20:00.000Z",
  "definition": {
    "schemaVersion": 1,
    "type": "generic",
    "description": "Gold membership card",
    "organizationName": "FORM Fitness",
    "colors": { "background": "#111827", "foreground": "#ffffff" },
    "platforms": { "apple": true, "google": true },
    "images": { "icon": "asset_Xr9Lm2Qv7Tn4Kp8Zs1Wd" },
    "config": {
      "fields": {
        "header": [],
        "primary": [
          { "key": "memberName", "label": "Member", "binding": "perPass", "required": true }
        ],
        "secondary": [
          { "key": "points", "label": "Points", "binding": "perPass", "required": false }
        ],
        "auxiliary": [],
        "back": []
      }
    }
  }
}

GET

templates

{id}

curl https://api.tapace.lk/v1/templates/tmpl_Q4vN8xT2mLr7KpZs3Wd1 \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "template",
  "id": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "type": "generic",
  "name": "Gold membership",
  "revision": 3,
  "archived": false,
  "requiredFields": ["memberName"],
  "createdAt": "2026-10-01T09:00:00.000Z",
  "updatedAt": "2026-10-12T15:20:00.000Z",
  "definition": {
    "schemaVersion": 1,
    "type": "generic",
    "description": "Gold membership card",
    "organizationName": "FORM Fitness",
    "colors": { "background": "#111827", "foreground": "#ffffff" },
    "platforms": { "apple": true, "google": true },
    "images": { "icon": "asset_Xr9Lm2Qv7Tn4Kp8Zs1Wd" },
    "config": {
      "fields": {
        "header": [],
        "primary": [
          { "key": "memberName", "label": "Member", "binding": "perPass", "required": true }
        ],
        "secondary": [
          { "key": "points", "label": "Points", "binding": "perPass", "required": false }
        ],
        "auxiliary": [],
        "back": []
      }
    }
  }
}

Use this to find the field keys a pass needs, or to copy a dashboard design as a starting point for creating a template.

string

required

The template ID, for example tmpl_Q4vN8xT2mLr7KpZs3Wd1.

The template object

string

Unique ID, starting with tmpl_.

string

generic or event_ticket.

string

The template’s name, up to 100 characters.

integer

Goes up by one each time the design changes. Send it as expectedRevision when you update the template.

boolean

Archived templates can’t issue new passes.

string[]

Keys of the per-pass fields every new pass must include in fieldValues.

object

The full design: colours, images, barcode, platforms and fields. Each field has a key, a label, a binding (shared or perPass) and a required flag.

string

When the template was created.

string

When the template last changed.

curl https://api.tapace.lk/v1/templates/tmpl_Q4vN8xT2mLr7KpZs3Wd1 \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "template",
  "id": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "type": "generic",
  "name": "Gold membership",
  "revision": 3,
  "archived": false,
  "requiredFields": ["memberName"],
  "createdAt": "2026-10-01T09:00:00.000Z",
  "updatedAt": "2026-10-12T15:20:00.000Z",
  "definition": {
    "schemaVersion": 1,
    "type": "generic",
    "description": "Gold membership card",
    "organizationName": "FORM Fitness",
    "colors": { "background": "#111827", "foreground": "#ffffff" },
    "platforms": { "apple": true, "google": true },
    "images": { "icon": "asset_Xr9Lm2Qv7Tn4Kp8Zs1Wd" },
    "config": {
      "fields": {
        "header": [],
        "primary": [
          { "key": "memberName", "label": "Member", "binding": "perPass", "required": true }
        ],
        "secondary": [
          { "key": "points", "label": "Points", "binding": "perPass", "required": false }
        ],
        "auxiliary": [],
        "back": []
      }
    }
  }
}

Getting started

Basics

Guides

API keys

Passes

Templates

Assets

Get a template

The template object

​The template object

The template object