Skip to main content
GET
Read a location's identity, hours and current open state

Authorizations

X-API-Key
string
header
required

Path Parameters

locationId
string<uuid>
required

Response

Current profile. Cache-Control: no-store, because isOpenNow is only true of the moment it was asked.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
timezone
string
required
Minimum string length: 1
address
object
required
schedule
object[]
required
scheduleSource
enum<string>
required
Available options:
location,
organization,
unconfirmed
isOpenNow
boolean
required
fulfillmentMethods
enum<string>[]
required
Available options:
takeout,
table_side,
room_service,
delivery