VIvibes
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_keystring required
wallet_idstring required

The wallet_id is the SmartLink token for a campaign.

Query parameters

group_codestring

optional group_code filter

expiration_datestring

optional expiration_date filter

providerstring

optional provider filter

field_namestring

optional first class field filter, where field_name == name of field to filter by

Headers

X-API-Versionstring

Response

Successful response

wallet_item_idstring

Unique Wallet Item ID that was specified at creation. This can be system generated or customer supplied in the creation URL.

group_codestring

Optional string value to indicate groups of related Wallet items. Can be used for targeted messaging.

activeboolean

TRUE if wallet item currently installed on person’s device.

tokensobject

Key/value pairs of item-specific data used to personalize this pass (referenced by personalization tags in the template).

providerstring

The wallet platform this item was issued to, for example passbook (Apple Wallet) or google_wallet (Google Wallet).

created_atstring

When the wallet item was created, in ISO-8601 format.

updated_atstring

When the wallet item was last updated, in ISO-8601 format.

urlstring

A reference URL to this wallet item, as a relative URL on the API domain.

Changes

No recorded changes to this operation across all 2 revisions of this API.