---
title: "Get store locations"
method: GET
path: "/companies/{company_key}/campaigns/wallet/{token}/locations"
tags: ["Wallet Store Locations API"]
---

# Get store locations

`GET /companies/{company_key}/campaigns/wallet/{token}/locations`

## Request

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

List the store locations attached to a wallet campaign. Results are paginated; use the `page` and `page_size` parameters to page through them.

## Path parameters

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

## Query parameters

- `page` integer
- `page_size` integer
- `zip` string
- `latitude` string
- `longitude` string

## Headers

- `X-API-Version` string

## Response `200`

Successful response

- WalletLocationResponse[]
  - `id` integer: Unique identifier of the store location.
  - `location_id` string: Your own identifier for the store (for example a store number).
  - `name` string: Store or location name.
  - `address` string: Street address.
  - `address_2` string: Optional second address line (suite, unit, etc.).
  - `city` string: City.
  - `state` string: State or province.
  - `zip` string: Zip or postal code.
  - `phone_number` string: Store contact phone number.
  - `store_hours` string: Store operating hours.
  - `latitude` string: Latitude of the location.
  - `longitude` string: Longitude of the location.
  - `notification_message` string: Lock-screen message shown to pass holders when they are near this location.

## Other responses

- `404`: The specified campaign does 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)
