Get a pass template

GET /pass-templates/{id}

Requires the pass_templates:read permission.

Authorization

X-API-Key required

Parameters

Name	Location	Type	Required
id	path	string	Yes

Request Examples

curl -X GET "https://api.remypass.com/api/v1/public/pass-templates/507f1f77bcf86cd799439011" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Use Case Examples

Get pass template by ID

curl -X GET https://api.remypass.com/api/v1/public/pass-templates/507f1f77bcf86cd799439012 \
  -H "X-API-Key: YOUR_API_KEY"

Responses

Status	Description
200	Pass template retrieved.
400	Bad request. The top-level message explains what is invalid and, where applicable, the errors array contains structured field details.
401	Missing or invalid API key.
403	The caller is not allowed to access this resource.
404	Resource not found.
429	Rate limit exceeded.
500	Server error.

200 Response Example

{
  "success": true,
  "message": "string",
  "data": {
    "_id": "507f1f77bcf86cd799439012",
    "name": "string",
    "description": "string",
    "type": "generic",
    "approved": true,
    "design": {
      "backgroundColor": "#0F172A",
      "foregroundColor": "#FFFFFF",
      "labelColor": "#CBD5E1",
      "voidedBackgroundColor": "#64748B",
      "logoText": "RemyPass",
      "icon": "https://cdn.remypass.com/passes/icon.png",
      "appleLogo": "https://cdn.remypass.com/passes/apple-logo.png",
      "googleLogo": "https://cdn.remypass.com/passes/google-logo.png",
      "googleWideLogo": "https://cdn.remypass.com/passes/google-wide-logo.png",
      "heroImage": "https://cdn.remypass.com/passes/hero.png",
      "stripImage": "https://cdn.remypass.com/passes/strip.png",
      "colorVariants": [
        {
          "id": "gold-members",
          "name": "Gold members",
          "field": "custom_membershipLevel",
          "operator": "is",
          "value": "Gold",
          "colors": {}
        }
      ]
    },
    "loyalty": {
      "initialStamps": 0,
      "maxStamps": 10,
      "emptyStampIconBgColor": "#FFFFFF",
      "filledStampIcon": "https://cdn.remypass.com/passes/filled-stamp.png",
      "filledStampIconBgColor": "#007BFF",
      "rewardIcon": "https://cdn.remypass.com/passes/reward.png",
      "stripBackgroundColor": "#F8F9FA",
      "stripBackgroundImage": "https://cdn.remypass.com/passes/loyalty-strip.png",
      "stampShape": "circle",
      "issueRewards": true,
      "deactivateOnMaxStamps": false,
      "rewardTitle": "Free Coffee",
      "rewardDescription": "Show this reward to claim your free coffee.",
      "stampSingular": "Stamp",
      "stampPlural": "Stamps"
    }
  }
}

Response Fields

Field	Type	Description	Attributes
success	boolean
message	string
data	object		Show child attributes _id: string name: string description: string type: generic, eventTicket, loyalty approved: boolean design: object — Visual design settings used when rendering Apple Wallet and Google Wallet passes. Show child attributes backgroundColor: string — Primary pass background color. foregroundColor: string — Primary text color. labelColor: string — Label text color. voidedBackgroundColor: string — Background color shown for voided passes. logoText: string — Text displayed alongside or instead of a logo where supported. icon: string (uri) — Icon image URL used by wallet platforms. appleLogo: string (uri) — Apple Wallet logo image URL. googleLogo: string (uri) — Google Wallet logo image URL. googleWideLogo: string (uri) — Google Wallet wide logo image URL, commonly used for loyalty passes. heroImage: string (uri) — Google Wallet hero image URL. stripImage: string (uri) — Apple Wallet strip image URL, commonly used for event tickets. colorVariants: array of object — Optional conditional color variants matched against member, pass, or custom field values. Show child attributes id: string — Variant id. name: string — Variant display name. field: string — Field to match, such as a custom field or member attribute. operator: is, is_not, contains, does_not_contain, more_than_years, less_than_years — Comparison to apply. Year-based operators compare the date field with the supplied number of years. value: string — Value that activates the variant. colors: object — Colors applied when the variant matches. loyalty: object — Loyalty pass configuration. Present for loyalty pass templates. Show child attributes initialStamps: integer — Number of stamps a loyalty pass starts with. maxStamps: integer — Number of stamps required to complete the loyalty card. emptyStampIconBgColor: string — Background color for empty stamp slots. filledStampIcon: string (uri) — Filled stamp icon image URL. filledStampIconBgColor: string — Background color for filled stamp slots. rewardIcon: string (uri) — Reward icon image URL. stripBackgroundColor: string — Background color for the loyalty stamp strip. stripBackgroundImage: string (uri) — Optional custom strip background image URL. stampShape: circle, rounded, square — Shape used for stamp slots. issueRewards: boolean — Whether rewards are issued automatically when the card reaches maxStamps. deactivateOnMaxStamps: boolean — Whether the loyalty pass is set inactive after reaching maxStamps. rewardTitle: string — Title used for generated rewards. rewardDescription: string — Description used for generated rewards. stampSingular: string — Singular label for a stamp. stampPlural: string — Plural label for stamps.