---
updatedAt: 2026-06-23T19:18:26.000Z
agentTools:
  projectIndex: https://developer-platform.vibes.com/llms.txt
---

# Get a wallet item

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Vibes Platform API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://public-api.vibescm.com",
      "description": "North America"
    },
    {
      "url": "https://public-api.eu.vibes.com/",
      "description": "EMEA"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Wallet Campaign API",
      "description": "Manage mobile wallet campaigns and the individual wallet items (passes) issued from them. A wallet campaign is the container for a single offer, loyalty card, or event ticket program; it owns the iOS and Android pass templates, the messages you send, and the store locations attached to the passes. Items are the per-recipient passes created when end users add a pass to Apple Wallet or Google Wallet."
    }
  ],
  "paths": {
    "/companies/{company_key}/campaigns/wallet/{wallet_id}/items/{wallet_item_id}": {
      "get": {
        "tags": [
          "Wallet Campaign API"
        ],
        "summary": "Get a wallet item",
        "parameters": [
          {
            "name": "X-API-Version",
            "in": "header",
            "schema": {
              "type": "string",
              "default": 1
            }
          },
          {
            "name": "company_key",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "wallet_id",
            "in": "path",
            "schema": {
              "type": "string",
              "description": "The `wallet_id` is the SmartLink token for a campaign."
            },
            "required": true
          },
          {
            "name": "wallet_item_id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/walletItemResponse"
                }
              }
            }
          },
          "404": {
            "description": "The specified `wallet_id` or `wallet_item_id` does not exist."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "schemas": {
      "walletItemResponse": {
        "type": "object",
        "properties": {
          "wallet_item_id": {
            "type": "string",
            "description": "Unique Wallet Item ID that was specified at creation. This can be system generated or customer supplied in the creation URL."
          },
          "group_code": {
            "type": "string",
            "description": "Optional string value to indicate groups of related Wallet items. Can be used for targeted messaging."
          },
          "campaign_ref": {
            "type": "object",
            "description": "Reference to the wallet campaign this item belongs to.",
            "properties": {
              "id": {
                "type": "string",
                "description": "The campaign's `wallet_id` (SmartLink token)."
              },
              "type": {
                "type": "string",
                "description": "Wallet campaign type."
              },
              "url": {
                "type": "string",
                "description": "Reference URL of the wallet campaign, as a relative URL on the API domain."
              }
            }
          },
          "active": {
            "type": "boolean",
            "description": "TRUE if wallet item currently installed on person’s device."
          },
          "tokens": {
            "type": "object",
            "description": "Key/value pairs of item-specific data used to personalize this pass (referenced by personalization tags in the template).",
            "additionalProperties": {
              "type": "string"
            }
          },
          "locations": {
            "type": "array",
            "description": "Geofenced locations that trigger a lock-screen reminder for this pass.",
            "items": {
              "type": "object",
              "properties": {
                "latitude": {
                  "type": "number",
                  "description": "Latitude of the location."
                },
                "longitude": {
                  "type": "number",
                  "description": "Longitude of the location."
                },
                "relevant_text": {
                  "type": "string",
                  "description": "Message shown on the device when the user is near the location."
                }
              }
            }
          },
          "provider": {
            "type": "string",
            "description": "The wallet platform this item was issued to, for example `passbook` (Apple Wallet) or `google_wallet` (Google Wallet)."
          },
          "passbook": {
            "type": "object",
            "description": "Apple Wallet (iOS) specific data for this item. Returned only for Apple Wallet passes.",
            "properties": {
              "notification": {
                "type": "string",
                "description": "Lock-screen notification text shown on the user's iOS device."
              }
            }
          },
          "google_wallet": {
            "type": "object",
            "description": "Google Wallet (Android) specific data for this item. Returned only for Google Wallet passes.",
            "properties": {
              "messages": {
                "type": "object",
                "description": "Update message shown on the user's Android device.",
                "properties": {
                  "header": {
                    "type": "string",
                    "description": "Message header."
                  },
                  "body": {
                    "type": "string",
                    "description": "Message body."
                  }
                }
              }
            }
          },
          "created_at": {
            "type": "string",
            "description": "When the wallet item was created, in ISO-8601 format."
          },
          "updated_at": {
            "type": "string",
            "description": "When the wallet item was last updated, in ISO-8601 format."
          },
          "url": {
            "type": "string",
            "description": "A reference URL to this wallet item, as a relative URL on the API domain."
          }
        }
      }
    }
  }
}
```