v2
latestOpenAPI 3.1.02026-08-074390396.7 KBPass Templates
List Pass Templates
List all pass templates
get/api/v1/pass-templates
Query parameters
perPageinteger
Record limiter per page. Default is 10, max is 100
pageinteger
Page number. Default is 1
templateTypestring
Filter by template type
status'draft' | 'published' | 'draft,published'
Example:draft,published
Filter by lifecycle status. Accepts a comma-separated list of one or more values. Defaults to published only when omitted.
fieldsstring
Example:name,description,templateType
Returns a partial response (Sparse fieldset) per record, instead of the whole record. Set one or many comma separated record attributes
Response
Successful
Example response
{
"data": [
{
"id": "19cb334f9696e64e10e7759f0",
"type": "passTemplate",
"attributes": {
"name": "PassEntry Supermarket",
"entityId": 1,
"defaultLanguage": "en",
"centralTitle": "PassEntry Supermarket",
"notificationHeader": "PassEntry Supermarket",
"status": "published",
"colors": {
"background": "#EFEFEF",
"label": "#FF8477",
"text": "#29323A"
},
"images": {
"banner": "https://example.com/banner.png",
"logo": "https://example.com/logo.png",
"icon": "https://example.com/icon.png",
"apple": {
"banner": "https://example.com/apple_banner.png",
"logo": "https://example.com/apple_logo.png",
"icon": "https://example.com/apple_icon.png",
"thumbnail": "https://example.com/apple_thumbnail.png"
},
"google": {
"banner": "https://example.com/google_banner.png",
"logo": "https://example.com/google_logo.png",
"wideLogo": "https://example.com/google_wide_logo.png"
}
},
"fields": {
"header": {
"one": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"two": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
}
},
"central": {
"one": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"two": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
}
},
"details": {
"one": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"two": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"three": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"four": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"five": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"six": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
}
},
"back": {
"one": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"two": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"three": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"four": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"five": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
},
"six": {
"id": "membership_tier",
"label": "Membership Tier",
"defaultValue": "Gold"
}
}
},
"appLinking": {
"apple": {
"appStoreUrl": [
"https://apps.apple.com/gb/app/whatsapp-messenger/id310633997"
]
},
"google": {
"web": {
"url": "https://passentry.com/"
}
}
},
"locations": [
{
"name": "West Entrance",
"latitude": 51.54321132456805,
"longitude": -0.022901231803803924,
"radius": 90,
"message": "Welcome! Enjoy the show!",
"address": "Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"
}
],
"beacons": [
{
"name": "West Entrance",
"proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
"major": 1246,
"minor": 6421,
"message": "You're near my store"
}
],
"barcode": {
"value": "abc123"
}
}
}
]
}