List Dynamic Pass Templates API

Overview

The List Dynamic Pass Templates API allows you to retrieve all dynamic pass templates associated with your account. This endpoint returns a list of templates with basic configuration information about each template. Each template represents a design and structure that can be used to generate multiple personalized passes for customers in associated user groups.

Authentication

All API requests must include your API key in the request headers:

"apikey": "your-api-key-here"

Request

This is a simple GET request that requires no parameters or request body. It returns all templates associated with your account.

GET /api/dynamicPass/templates
apikey: your-api-key-here

Response

The API returns a JSON array containing template objects with their complete configuration:

Response Example

[
  {
    "template": {
      "cardType": "Dynamic Card",
      "cardSubType": "dynamic_loyalty_stamp_card",
      "passType": "generic",
      "genericType": "GENERIC_TYPE_UNSPECIFIED",
      "cardTitle": "Cafe Muse",
      "header": "FREE COFFEE",
      "subheader": "REWARD ON 5TH VISIT",
      "textModulesData": [
        {
          "id": "r1start",
          "header": "Name",
          "body": "{{full_name}}"
        },
        {
          "id": "r1end",
          "header": "Member ID",
          "body": "{{c_id}}"
        }
      ],
      "barcodeType": "QR_CODE",
      "hexBackgroundColor": "#45290d",
      "appleFontColor": "#ffffff",
      "heroImage": "https://s3.amazonaws.com/i.addtowallet.co/addtowallet-7de8b055-2490-49f7-a3ce-2ef4cd6035a2",
      "logoUrl": "https://s3.amazonaws.com/i.addtowallet.co/addtowallet-7d9d988b-0e87-4481-8e1d-5d2d022fb6a6"
    },
    "dynamicPassId": "685e9888cc33237826b720f8"
  },
  {
    "template": {
      "cardType": "Business Card",
      "passType": "generic",
      "genericType": "GENERIC_TYPE_UNSPECIFIED",
      "logoUrl": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatelogo.png",
      "cardTitle": "{org}",
      "header": "{name}",
      "textModulesData": [
        {
          "id": "r1start",
          "header": "Phone",
          "body": "+1 8888888888"
        },
        {
          "id": "r1end",
          "header": "Email",
          "body": "{email}"
        }
      ],
      "linksModuleData": [
        {
          "id": "r1",
          "description": "Call Us",
          "uri": "tel:+1 8287489293"
        },
        {
          "id": "r2",
          "description": "Email Us",
          "uri": "mailto:[email protected]"
        }
      ],
      "barcodeType": "QR_CODE",
      "hexBackgroundColor": "#141f31",
      "appleFontColor": "#FFFFFF",
      "heroImage": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatehero.png",
      "stateType": "ACTIVE"
    },
    "dynamicPassId": "68654e70efe914f4fefe6371"
  }
]

Use Cases

• Display a list of available templates in your application
• Allow users to browse and select templates for pass creation
• Monitor all templates and their configurations
• Identify templates with specific design elements or placeholders
• Audit template usage across your organization
• Export template configurations for backup or migration
• Review templates associated with specific user groups