---
title: "Get wallet items"
method: GET
path: "/companies/{company_key}/campaigns/wallet/{wallet_id}/items"
tags: ["Wallet Campaign API"]
---

# Get wallet items

`GET /companies/{company_key}/campaigns/wallet/{wallet_id}/items`

## Request

- Base URL: `https://public-api.vibescm.com`
- URL: `https://public-api.vibescm.com/companies/{company_key}/campaigns/wallet/{wallet_id}/items`
- Auth: HTTP basic

## Path parameters

- `company_key` string, required
- `wallet_id` string, required: The `wallet_id` is the SmartLink token for a campaign.

## Query parameters

- `group_code` string
- `expiration_date` string
- `provider` string
- `field_name` string

## Headers

- `X-API-Version` string

## Response `200`

Successful response

- WalletItemResponse[]
  - `wallet_item_id` string: Unique Wallet Item ID that was specified at creation. This can be system generated or customer supplied in the creation URL.
  - `group_code` string: Optional string value to indicate groups of related Wallet items. Can be used for targeted messaging.
  - `campaign_ref` object: Reference to the wallet campaign this item belongs to.
    - `id` string: The campaign's `wallet_id` (SmartLink token).
    - `type` string: Wallet campaign type.
    - `url` string: Reference URL of the wallet campaign, as a relative URL on the API domain.
  - `active` boolean: TRUE if wallet item currently installed on person’s device.
  - `tokens` object: Key/value pairs of item-specific data used to personalize this pass (referenced by personalization tags in the template).
  - `locations` object[]: Geofenced locations that trigger a lock-screen reminder for this pass.
    - `latitude` number: Latitude of the location.
    - `longitude` number: Longitude of the location.
    - `relevant_text` string: Message shown on the device when the user is near the location.
  - `provider` string: The wallet platform this item was issued to, for example `passbook` (Apple Wallet) or `google_wallet` (Google Wallet).
  - `passbook` object: Apple Wallet (iOS) specific data for this item. Returned only for Apple Wallet passes.
    - `notification` string: Lock-screen notification text shown on the user's iOS device.
  - `google_wallet` object: Google Wallet (Android) specific data for this item. Returned only for Google Wallet passes.
    - `messages` object: Update message shown on the user's Android device.
      - `header` string: Message header.
      - `body` string: Message body.
  - `created_at` string: When the wallet item was created, in ISO-8601 format.
  - `updated_at` string: When the wallet item was last updated, in ISO-8601 format.
  - `url` string: A reference URL to this wallet item, as a relative URL on the API domain.

## Other responses

- `404`: The specified mobile wallet campaigns or wallet items do not exist.

---

[API](https://skmtc.dev/vibes/apis/vibes-platform-api.md) - [All operations](https://skmtc.dev/vibes/apis/vibes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vibes/apis/vibes-platform-api/revisions/e235838f2e50?raw)