GET api/v1/organisations/{organisationKey}/groups/type/{groupType}?includeArchived={includeArchived}

Endpoint to query all the groups with a given grouptype of a specific organisation.

Request Information

Name	Description	Type	Additional information
organisationKey	The key that identifies the organisation for which the groups must be retrieved.	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.
groupType	The value of the GroupType.	GroupType	None.
includeArchived	To also return archived groups, default = false.	boolean	Default value is False

None.

List of groups of a specific organisation.

Collection of Group

Name	Description	Type	Additional information
Name		string	Required
FunctionName		string	None.
Status		GroupStatus	None.
SchoolYear		integer	None.
Type		GroupType	Required
OrganisationKey		globally unique identifier	Required
Users		Collection of User	None.
AccountPngPicture		string	None.
AccountPngPictureUrl		string	None.
ActiveDirectoryId		string	None.
ResourceLockStatus	Indicates whether the resource is locked for editing (e.g. by Basispoort).	ResourceLockStatus	None.
ResourceLockOwnerName	Holds the name of the owner of the resource lock in case the ResourceLockStatus is Locked.	string	None.
IsLocked	This property is only added for backwards compatibility, but will be removed before release.	boolean	None.
SystemRoleType		GroupSystemRoleIdentificationMarkType	None.
InsertDate		date	None.
ModifiedDate		date	None.
AdImportSid		string	None.
GroupLoginAdImportSid		string	None.
GroupTemplateKey		globally unique identifier	None.
ActionLinks		Collection of Link	None.
Key		globally unique identifier	None.