Get organisation

Request

Get all attributes of an organisation model given an organisation ID.

Security

api_key

Path

organisationIdstring, (uuid)required

The ID of the organisation to be returned.

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

Responses

OK.

Bodyapplication/json

createdAtstring, (date-time)read-only

idstring, (uuid)

licenceArray of strings

Items Enum:"data_explorer""occupancy_monitor""people_count""real_time""dwell_time"

maxAdminSeatsinteger or null, (uint64), >= 0

maxUserSeatsinteger or null, (uint64), >= 0

namestring

processingGroupinteger or null, (int64), >= 0

statestring

Enum:"active""churned""disabled"

Response

{
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "licence": [
    "data_explorer"
  ],
  "maxAdminSeats": 0,
  "maxUserSeats": 0,
  "name": "string",
  "processingGroup": 0,
  "state": "active"
}