Skip to content

List sites

Request

List all the sites in the portfolio along with the organisations that own them.

Security
api_key
Query
organisationIdstring, (uuid)

The ID of an organisation.

userIdstring

The ID of a user.

statestring

Site state.

Enum:"active""deleted"
includeInactiveOrgsboolean

When true, include resources of inactive (disabled or churned) organisations. Only honoured for callers with the corresponding :all permission.

Default:false
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/sites?organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&userId=string&state=active&includeInactiveOrgs=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
addressstring
idstring or null, (uuid)
namestring, non-emptyrequired
openingHourobject or null
organisationIdstring, (uuid)
statestring
Enum:"active""deleted"
tzstring, non-emptyrequired

The IANA time zone of the site, e.g. Europe/London.

]
Response
[
  {
    "address": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "openingHour": {},
    "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
    "state": "active",
    "tz": "string"
  }
]