List locations

Lists your locations, newest first - each row is the full Location object: address + pin, geo notification, enabled cards with their per-location signup URLs, assigned team, and POS-bridge status. Organizations have few locations, so no slim row shape exists; one call gives you everything the dashboard’s location screen shows. Scope: locations:read.

Locations are created and deleted in the dashboard only - each location is a billing unit, so lifecycle changes go through the billing consent flow there. The API reads and edits.

See Pagination.

GET /v1/locations

List locations

cURL

curl --request GET \
  --url https://api.vexioncards.one/v1/locations \
  --header 'Authorization: Bearer <token>'

200

Two stores

{ "object": "list", "data": [ { "id": "loc_01HW9R4P2ZK7N8MTX1RVLOCS01", "object": "location", "name": "Demo Coffee - City Center", "address": "Hlavná 12, 811 01 Bratislava, Slovakia", "coordinates": { "latitude": 48.1486, "longitude": 17.1077 }, "country": "SK", "geo_message": "You're near Demo Coffee - your 10th coffee is on us today! ☕", "geo_message_enabled": true, "enabled_card_ids": [ "crd_56gd3jpqoipsfjoa7cjabfqope", "crd_2hh2fekk5zazfyyvian4uhepyq" ], "cards": [ { "card_id": "crd_56gd3jpqoipsfjoa7cjabfqope", "name": "Coffee Stamp Card", "type": "stamp", "signup_url": "https://vexioncards.one/signup/?id=crd_56gd3jpqoipsfjoa7cjabfqope&loc=loc_01HW9R4P2ZK7N8MTX1RVLOCS01" }, { "card_id": "crd_2hh2fekk5zazfyyvian4uhepyq", "name": "Coffee Points", "type": "reward", "signup_url": "https://vexioncards.one/signup/?id=crd_2hh2fekk5zazfyyvian4uhepyq&loc=loc_01HW9R4P2ZK7N8MTX1RVLOCS01" } ], "team_members": [ { "team_member_id": "tm_01HW9R6M4XQ2N8MTX1RVTM0001", "name": "Anna K.", "role": "scanner" }, { "team_member_id": "tm_01HW9R6M4XQ2N8MTX1RVTM0002", "name": "Peter V.", "role": "manager" } ], "pos_connected": true, "is_default": true, "is_active": true, "created_at": 1735689600, "updated_at": 1751500000 }, { "id": "loc_01HW9R4P2ZK7N8MTX1RVLOCS02", "object": "location", "name": "Demo Coffee - Riverside", "address": "Nábrežná 3, 811 02 Bratislava, Slovakia", "coordinates": { "latitude": 48.1411, "longitude": 17.1093 }, "country": "SK", "geo_message": null, "geo_message_enabled": false, "enabled_card_ids": [ "crd_56gd3jpqoipsfjoa7cjabfqope" ], "cards": [ { "card_id": "crd_56gd3jpqoipsfjoa7cjabfqope", "name": "Coffee Stamp Card", "type": "stamp", "signup_url": "https://vexioncards.one/signup/?id=crd_56gd3jpqoipsfjoa7cjabfqope&loc=loc_01HW9R4P2ZK7N8MTX1RVLOCS01" } ], "team_members": [], "pos_connected": false, "is_default": false, "is_active": true, "created_at": 1735689600, "updated_at": 1751500000 } ], "has_more": false, "url": "/v1/locations" }

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Query Parameters

limit · integer · default: 25

1-100. Default 25.

Required range: 1 <= x <= 100

starting_after · string

Cursor - the loc_ id of the last item on the previous page (forward). Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism.

Pattern: ^loc_[A-Za-z0-9]+$

ending_before · string

Reverse cursor - returns items before this loc_ id.

Pattern: ^loc_[A-Za-z0-9]+$

Response

200

application/json

Paginated location list.

Standard cursor-pagination envelope - see Pagination.

object · enum<string> · required

Always "list".

Available options: list

data · object[] · required

Array of the requested resource type.

Show child attributes

has_more · boolean · required

True when more pages exist.

next_cursor · string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url · string

Stable collection URL.