Build your own websiteAPI referenceLocations
List active locations
Query Parameters
search?string
Search term for title, description
locationType?string
Filter by location type
Value in
- "city"
- "district"
- "neighborhood"
- "area"
- "zone"
- "compound"
parentLocationId?string
Filter by parent location ID
isFeature?boolean
Filter by featured status
orderBy?
Order by field and direction (JSON string or object)
page?number
Page number
Range
1 <= valueDefault
1perPage?number
Items per page
Range
1 <= value <= 100Default
10Header Parameters
X-Site*string
The site key identifying which website this request belongs to. May be omitted only when the request comes from a domain already verified for the site (the Origin/Host then resolves it), or when the deprecated X-Subdomain header is used.
X-Api-Key?string
Publishable (pk_…) or secret (sk_…) key for this site. Required on writes; accepted on reads. NOTE: currently rolling out in monitor mode — a write without a valid key is logged rather than refused, so this is documented as optional. It becomes required on writes when enforcement is switched on; send it now.
Response Body
curl -X GET "https://example.com/api/public/locations" \ -H "X-Site: string"Empty