v2
latestOpenAPI 3.1.12026-08-06856719.6 KBLocation
List locations
Returns a paginated list of locations for the authenticated business.
The business is resolved from the API key (X-BUSINESS-API-KEY) or OAuth bearer token. Cashiers and managers only see locations assigned to them.
get/v1/locations
Query parameters
keywordsstring
Filter by location name (space-separated keywords) or exact UUID
perPageinteger
Number of results per page
Headers
X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d
Response
Paginated list of locations
Example response
{
"data": [
{
"id": "9c484458-b2a3-4f49-87ed-ad9ea71b0df3",
"business_id": "8a1f2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
"name": "Main Store",
"street": "123 Main St",
"city": "Singapore",
"state": "Singapore",
"country": "SG",
"postal_code": "123456",
"active": true
}
],
"meta": {
"current_page": 5,
"per_page": 10,
"from": 1,
"to": 10,
"total": 100,
"last_page": 10
}
}