Get Passes API

Overview

Retrieve all passes created by the authenticated user. Supports use cases where your system needs to list existing passes for management or synchronization.

Authentication

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

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

Request Parameters

No query parameters are required.

curl -X GET 'https://api.addtowallet.co/api/card/get' -H 'apikey: YOUR_API_KEY'

Sample Response

A successful response returns the list of passes for the authenticated user. Pass objects may include thumbnailImage, backgroundImage, and a derived applePassLayout value when Apple event-ticket layout is active. These are read-only response fields — set thumbnailImage and/or backgroundImage on create/update to enable the layout; do not send applePassLayout as input.

{
  "cards": [
    {
      "_id": "66b6005bb7bddce8f05a3392",
      "cardTitle": "Your Business Name",
      "header": "Amy Jane",
      "subheader": "Senior Developer",
      "logoUrl": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatelogo.png",
      "rectangleLogo": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatelogo.png",
      "heroImage": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatehero.png",
      "googleHeroImage": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatehero.png",
      "appleHeroImage": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatehero.png",
      "hexBackgroundColor": "#141f31",
      "appleFontColor": "#FFFFFF",
      "barcodeType": "QR_CODE",
      "barcodeValue": "",
      "barcodeAltText": "",
      "linksModuleData": [
        { "id": "r1", "description": "Call Us", "uri": "tel:+1 8287489293" },
        { "id": "r2", "description": "Email Us", "uri": "mailto:[email protected]" },
        { "id": "r3", "description": "Visit our website", "uri": "https://app.addtowallet.co" },
        { "id": "r4", "description": "Visit our office", "uri": "geo:https://maps.google.com/?q=123+Main+Street,+Anytown,+CA" }
      ],
      "textModulesData": [
        { "id": "r1start", "header": "Phone", "body": "+1 8888888888" },
        { "id": "r1end", "header": "Email", "body": "[email protected]" }
      ],
      "stateType": "ACTIVE",
      "createdAt": "2024-08-09T10:20:30.000Z",
      "updatedAt": "2024-08-10T15:41:12.000Z"
    }
  ],
  "count": 1,
  "pagination": { "page": 1, "limit": 20, "totalPages": 1, "totalItems": 1 }
}

Error Codes