GET api/v1/organisations/{key}
Endpoint to get an organisation by Key.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
Key of the organisation. |
globally unique identifier |
Required |
| Select | Collection of string |
None. |
|
| OrderBy | Collection of TupleOfStringAndOrderDirection |
None. |
|
| Top | integer |
None. |
|
| Skip | integer |
None. |
|
| PageSize | integer |
None. |
|
| Page | integer |
None. |
|
| SearchText | string |
None. |
|
| Expand | Dictionary of string [key] and MooQueryOptions [value] |
None. |
|
| SearchParameters | Dictionary of string [key] and string [value] |
None. |
Body Parameters
None.
Response Information
Resource Description
Organisation of given Key.
Organisation| Name | Description | Type | Additional information |
|---|---|---|---|
| Tenant | Tenant |
None. |
|
| Name | string |
None. |
|
| City | string |
None. |
|
| Brin | string |
None. |
|
| CrmId | integer |
None. |
|
| LoginDomain | string |
None. |
|
| ActiveDirectoryID | integer |
None. |
|
| AdImportMode | boolean |
None. |
|
| LoginNameFormatStudent | string |
None. |
|
| LoginNameFormatPersonnel | string |
None. |
|
| BoardOrganisationKey | globally unique identifier |
None. |
|
| LicenseKeys | Collection of globally unique identifier |
None. |
|
| DefaultFunctionKey | globally unique identifier |
None. |
|
| PlatformFlags | PlatformFlags |
None. |
|
| Key | globally unique identifier |
None. |