Skip to content

Get site

Request

Get all attributes of a site model given a site ID.

Security
api_key
Path
siteIdstring, (uuid)required

The ID of the site to be returned.

curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/sites/{siteId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
addressstring
idstring or null, (uuid)
namestring, non-emptyrequired
openingHourobject or null
organisationIdstring, (uuid)
statestring
Enum:"active""deleted"
tzstring
Response
{
  "address": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "openingHour": {},
  "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  "state": "active",
  "tz": "string"
}