NameDescriptionTypeAdditional information
SportIds

The groups in the result must have a connection to at least any of the provided SportIds.
Should contain Id for one main sport or one or more subsports.

Collection of integer

Required

Since

If set, the result will contain changes from this time and later only. If a group is added, changed, removed or any of the groups' or group members' following entities are changed

  • Address
  • Contacts
  • Licenses
  • Roles
  • RoleAttributes
then the service will treat the group as changed.

If not set, the result will contain the current information available.

Groups in organisations that no longer have any connection to any of the SportIds, will not be returned.

date

None.

OrganisationIds

The ids of the top level organisations to get groups for. If parameter IncludeUnderlyingOrganisations is set to true, then the response will also include groups for underlying organisations. I.e. if you provide an OrganisationId for an SF, you will also get groups from Regions, SDFs, SubSports (Gren/Klass) and Clubs, if parameter IncludeUnderlyingOrganisations is set to true.

Collection of integer

None.

IncludeUnderlyingOrganisations

Set to false to not include groups from underlying organisations in the result.

boolean

Default value: true

OrganisationTypeIds

Used to restrict the results to only include groups connected with organisations of a type in the provided OrganisationTypeIds.

Collection of integer

Default value: All

GroupIds

If GroupIds is specified, then only groups in GroupIds will be returned. These groups still needs to fulfill all other parameters.

Collection of integer

None.

GroupTypeIds

Used to restrict the results to only include groups of a type in the provided GroupTypeIds.

Collection of integer

Default value: All

ReturnLicenses

Set to true to include licenses in the response.

boolean

Default value: true

SearchLicenses

Set to true to search for changes in licenses. Only applicable when Since date is set.

boolean

Default value: true

ReturnGroupMemberContacts

Set to true to return group member contacts in the response.

boolean

Default value: true

SearchGroupMemberContacts

Set to true to search for changes in group member contacts. Only applicable when Since date is set.

boolean

Default value: true