--- title: "Show Pass Template" method: GET path: "/api/v1/pass-templates/{id}" tags: ["Pass Templates"] --- # Show Pass Template `GET /api/v1/pass-templates/{id}` ## Path parameters - `id` string, required ## Query parameters - `fields` string ## Response `200` Successful - object - `data` union - SerializedPassTemplate - `id` string — Unique identifier for the pass template - `type` string - `attributes` object - `name` string — Name of the pass template, used for display purposes - `entityId` integer — ID of the entity this pass template belongs to - `templateType` 'generic' | 'loyalty' | 'eventTicket' | 'transit' - `transitType` 'airplane' | 'bus' | 'train' | 'ferry' | 'other' — Transit type for the transit pass template - `defaultLanguage` string — Language code (ISO 639-1) used as the default language for labels on this template - `centralTitle` string — Used for Google Wallet Passes, pass Title - `notificationHeader` string — Header text to be displayed on notifications - `status` 'draft' | 'published' — Lifecycle status of the pass template. - `colors` PassTemplateColors - `background` string — Background color of the pass template - `label` string — Label color of the pass template - `text` string — Text color of the pass template - `images` PassTemplateImages - `banner` string — Banner image URL, used unless platform specific images are provided - `logo` string — Logo image URL, used unless platform specific images are provided - `icon` string — Icon image URL, used unless platform specific images are provided - `watermark` ImageWatermark - `color` 'light' | 'dark' — Color of the watermark, light or dark - `position` 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' — Position of the watermark, top left, top right, bottom left, or bottom right - `apple` object - `banner` string — Banner image URL, used for Apple Wallet - `logo` string — Logo image URL, used for Apple Wallet - `icon` string — Icon image URL, used for Apple Wallet - `thumbnail` string — Thumbnail image URL, used for Apple Wallet - `watermark` ImageWatermark - … - `google` object - `banner` string — Banner image URL, used for Google Wallet - `logo` string — Logo image URL, used for Google Wallet - `wideLogo` string — Wide logo image URL, used for Google Wallet - `watermark` ImageWatermark - … - `fields` PassTemplateFields — Fields for the pass template, for exact positioning of fields please review our design guidelines - `header` HeaderField - `one` Field — Field object. Set value to null to remove the field. - … - `two` Field — Field object. Set value to null to remove the field. - … - `central` CentralField — Central field for the pass template. **Note**: Please use both `one` and `two` fields for `transit` type - `one` Field — Field object. Set value to null to remove the field. - … - `two` Field — Field object. Set value to null to remove the field. - … - `details` DetailsField - `one` Field — Field object. Set value to null to remove the field. - … - `two` Field — Field object. Set value to null to remove the field. - … - `three` Field — Field object. Set value to null to remove the field. - … - `four` Field — Field object. Set value to null to remove the field. - … - `five` Field — Field object. Set value to null to remove the field. - … - `six` Field — Field object. Set value to null to remove the field. - … - `back` BackField - `one` Field — Field object. Set value to null to remove the field. - … - `two` Field — Field object. Set value to null to remove the field. - … - `three` Field — Field object. Set value to null to remove the field. - … - `four` Field — Field object. Set value to null to remove the field. - … - `five` Field — Field object. Set value to null to remove the field. - … - `six` Field — Field object. Set value to null to remove the field. - … - `appLinking` AppLinking — Used to add a link on your pass to an app or website. - `apple` object - `appStoreUrl` string[] - `google` union — Link to your android App or website - object - … - object - … - `locations` SerializedLocation[] — Array of locations. Maximum of 10 locations - `name` string — Name of the location, used for display purposes only - `latitude` number, double — Latitude of the location - `longitude` number, double — Longitude of the location - `radius` integer — Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types. Currently only available on Apple devices, due to Android device restrictions. - `message` string — Message to display when user enters geofence. Currently only available on Apple devices, due to Android device restrictions. - `address` string — Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values - `beacons` Beacon[] — Array of beacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 beacons - `name` string, required — Name of the beacon, used for display purposes only - `proximityUuid` string, required — Unique identifier of the beacon - `major` integer — Major Value, provides additional identification for a beacon - `minor` integer — Minor Value, provides additional identification for a beacon - `message` string, nullable — Message to display on lock screen when the user is in range of the beacon - `barcode` Barcode — Barcode for a pass template - `enabled` boolean — If true, barcode will be added to the pass - `type` 'qr' | 'code128' | 'aztec' | 'pdf417' — Barcode type - `source` 'custom' | 'uuid' | 'extId' — Source of the barcode - `value` string — Barcode value. You can leave it blank if the value will be dynamically set in the pass, but you can also provide a default. You can make the value dynamic using the `%{passData.xyz}` syntax (e.g., `Hello, %{passData.extId}`). Currently, only `%{passData.extId}` and `%{passData.uuid}` are supported. If `source` is set to `extId` or `uuid`, the value will be automatically populated and can be left blank. - `displayText` boolean — If true, display the barcode value as text on the pass - `loyaltyBalance` PassTemplateLoyaltyBalance — Loyalty balance for the pass template. - `enabled` boolean — If enabled, pass will have a loyalty balance field that can be updated via the loyalty API. - `numberType` 'integer' | 'decimal' — Type of number to be displayed on the pass, number will be converted to this type. - `googleNfcEnabled` boolean — Only included on loyalty templates, if true, pass will be enabled for Google Wallet NFC. - `hasDynamicForm` boolean — If true, pass template has a dynamic pass issuance form associated with it. - `enhancedEventTicket` object — Poster event ticket configuration. Only present on event ticket templates with enhanced event ticket enabled. ***Note**: This feature is in **closed beta**. The API structure may change and you may encounter bugs. Please contact PassEntry for access.* - `images` object — Poster event ticket images. - `artwork` string — URL of the artwork image. - `secondaryLogo` string — URL of the secondary logo image. - `venueMap` string — URL of the venue map image. - SerializedProcessingPassTemplate - `id` string — Unique identifier for the pass template - `type` string - `attributes` object - `name` string — Name of the pass template, used for display purposes - `templateType` 'eventTicket' | 'loyalty' | 'generic' | 'transit' — Type of pass template, determines the design and functionality of the pass - `transitType` 'airplane' | 'bus' | 'train' | 'ferry' | 'other' — Transit type for the transit pass template - `processingStatus` 'processing' | 'processed' | 'failed' | 'updating' — Processing status of the pass template - `status` 'draft' | 'published' — Lifecycle status of the pass template. - `meta` object - `message` string — Processing status message - `links` object - `self` string — URL to the pass template. Use this URL to retrieve the pass template once it has been processed. ## Other responses - `401` — Error: Unauthorized - `404` — Error: Not Found --- [API](https://skmtc.net/passentry/apis/passentry-api.md) · [All operations](https://skmtc.net/passentry/apis/passentry-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/passentry/passentry-api/versions/2c7dc0306b04/schema)