GET
/
wallet-pass-location
/
{locationId}
Get a Pass location
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass-location/{locationId} \
  --header 'api-key: <api-key>'
{
  "name": "Main Store",
  "enabled": true,
  "latitude": 37.7749,
  "longitude": -122.4194,
  "relevantText": "You are near Main Store!",
  "passSerialNumber": "pass-123"
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
locationId
string
required

Response

Success

​
name
string
required

Name of the location. This field is required and has a maximum length of 255 characters.

Maximum length: 255
Example:

"Main Store"

​
latitude
number
required

Latitude of the location in degrees. This field is required.

Example:

37.7749

​
longitude
number
required

Longitude of the location in degrees. This field is required.

Example:

-122.4194

​
relevantText
string
required

Text to display on the lock screen when the user is near this location. This field is required and has a maximum length of 255 characters.

Maximum length: 255
Example:

"You are near Main Store!"

​
passSerialNumber
string
required

The ID of the Pass that this location is associated with. This field is required when creating a location.

Example:

"pass-123"

​
enabled
boolean

Indicates whether the location is enabled. If true, the Pass may trigger a notification when the user is near this location. Default is true if not specified.

Example:

true