API Documentation

Everything you need to interact with AccessGrid.

List Card Template Pairs

Enterprise only
Contact us

Only available for enterprise customers - allows you to retrieve a paginated list of Card Template Pairs. Card Template Pairs link iOS and Android card templates together for unified pass issuance.

page

nullable integer

All

per_page

nullable integer

All

Request

Response

{ "card_template_pairs": [ { "id": "pair_9f3a12bc", "ex_id": "pair_9f3a12bc", "name": "Corporate Access Badge", "created_at": "2025-12-01T09:15:30Z", "android_template": { "id": "tpl_android123", "ex_id": "tpl_android123", "name": "Android Corporate Badge", "platform": "android" }, "ios_template": { "id": "tpl_ios456", "ex_id": "tpl_ios456", "name": "iOS Corporate Badge", "platform": "apple" } }, { "id": "pair_b81d77ef", "ex_id": "pair_b81d77ef", "name": "Student ID", "created_at": "2025-11-15T14:22:11Z", "android_template": { "id": "tpl_android789", "ex_id": "tpl_android789", "name": "Android Student ID", "platform": "android" }, "ios_template": null } ], "pagination": { "current_page": 1, "per_page": 50, "total_pages": 1, "total_count": 2 } }

Create Card Template Pair

Enterprise only
Contact us

Only available for enterprise customers - allows you to create a Card Template Pair by linking an Apple (iOS) and Google (Android) card template together. Both templates must be published. Supported combinations are either Apple SEOS paired with Google SEOS, or Apple DESFire paired with Google SmartTap.

name

string

All

apple_card_template_id

string

All

google_card_template_id

string

All

Request

Response

{ "id": "pair_9f3a12bc", "ex_id": "pair_9f3a12bc", "name": "Corporate Access Badge", "created_at": "2025-12-01T09:15:30Z", "android_template": { "id": "tpl_android123", "ex_id": "tpl_android123", "name": "Android Corporate Badge", "platform": "android" }, "ios_template": { "id": "tpl_ios456", "ex_id": "tpl_ios456", "name": "iOS Corporate Badge", "platform": "apple" } }

Update Card Template Pair

Enterprise only
Contact us

Only available for enterprise customers - renames a card template pair. Only name can be changed.

card_template_pair_id

string

All

name

string

All

Request

Response

{ "id": "pair_9f3a12bc", "ex_id": "pair_9f3a12bc", "name": "Updated Corporate Access Badge", "created_at": "2025-12-01T09:15:30Z", "android_template": { "id": "tpl_android123", "ex_id": "tpl_android123", "name": "Android Corporate Badge", "platform": "android" }, "ios_template": { "id": "tpl_ios456", "ex_id": "tpl_ios456", "name": "iOS Corporate Badge", "platform": "apple" } }

Delete Card Template Pair

Enterprise only
Contact us

Only available for enterprise customers - deletes a card template pair. Every key issued through the pair must be deleted first, otherwise returns 422 with an active_key_count field. The two card templates the pair links are not deleted.

card_template_pair_id

string

All

Request

Response

{ "id": "0xpa1rt3mp14t3", "deactivated": true }