Skip to content

Organisations

APIs to manage Organisations.

Operations

List organisations

Request

List organisations in the portfolio.

Security
api_key
Query
userIdstring, (uuid)

The ID of a user.

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/organisations?userId=497f6eca-6276-4993-bfeb-53cbbbba6f08&includeInactiveOrgs=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
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": [ … ],
    "maxAdminSeats": 0,
    "maxUserSeats": 0,
    "name": "string",
    "processingGroup": 0,
    "state": "active"
  }
]