Locations
Get a location
Read one location and its optional attached information.
GET
Requires
JavaScript examples run in Node.js 22 or later; PHP examples require PHP 8.2 or later with cURL. Both read
The full resource also includes
location:read and project API access. The location must belong to the project in the URL.
Send
1 to include the holiday and special hours that apply to the location in the next two months. Read-only.STOREROCKET_TOKEN from your environment. See the quickstart for setup.
Response format
Successful reads and writes return200 with a data object. The example below shows selected fields with illustrative values.
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.