Skip to main content
GET
Requires location:read and project API access. The location must belong to the project in the URL.
​
string
required
The public project ID.
​
string
required
The public location ID.
​
integer
Send 1 to include opening hours.
​
integer
Send 1 to include filters.
​
integer
Send 1 to include custom fields.
​
integer
Send 1 to include calls to action.

​
Response format

Successful reads and writes return 200 with a data object. The example below shows selected fields with illustrative values.
The full resource also includes slug, visible, display_address, address components, timezone, email, url, and social fields. location_type is a name or null; marker IDs are integers or null. Read cover_image_url for the cover, and send cover when writing it. hours, filters, fields, and callsToAction are included on GET only when requested with their include flags. No schedule returns hours: null. A write response includes these relationships automatically. Custom fields and calls to action are arrays in responses, even though writes use named objects. Location responses do not include created_at or updated_at. Errors: 401 authentication, 403 access/permission, 404 inaccessible project or location, 429 rate limit. See errors.