v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB

Organisations

Get organisation by ID

get/organisations/view/{organisationId}

Path parameters

string required

string uuid required

Example:12345

UUID or numeric ID of the organisation

Response

Organisation list response

idstring

namestring

date_createdstring

date_modifiedstring

descriptionstring

typestring nullable

nationalitystring

sectorstring

created_bystring

uuidstring

contactsstring nullable

localboolean

restricted_to_domainstring[]

landingpagestring nullable

user_countstring nullable

created_by_emailstring nullable

Example response

{
  "id": "12345",
  "name": "ORGNAME",
  "date_created": "2021-06-14 14:29:19",
  "date_modified": "2021-06-14 14:29:19",
  "type": "ADMIN",
  "created_by": "12345",
  "user_count": "3"
}