Skip to main content
GET
List locations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

Opaque cursor returned in next_cursor.

limit
integer
default:50
Required range: 1 <= x <= 200
externalVendor
string

Filter to a specific POS vendor (e.g. square, toast, lightspeed, clover, aloha-cloud).

externalLocationId
string

Filter by the vendor-side location id the operator linked in their integrations admin UI. Combined with externalVendor this is the standard "what's Perkstar's UUID for my Square location L4F1Z2K?" lookup.

active
boolean

Filter by the operator's per-location active toggle. Inactive locations are skipped by geo-push + pkpass relevance.

Response

OK

has_more
boolean
required
next_cursor
string | null
required
limit
integer
required
data
object[]
required