List child groups

Get children groups from a given groupId.

get/v2/organisation/groups/{groupId}/children

Path parameters

groupIdinteger required

Query parameters

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

Returns group details.

idinteger

namestring

groupType'domain' | 'district' | 'unit' | 'section'

parentGroupIdinteger

Example response

[
  {
    "id": 170305,
    "name": "Stockholm Central",
    "groupType": "unit",
    "parentGroupId": 170300,
    "districtAttributesDto": {
      "districtId": 567,
      "managerId": 1234
    },
    "sectionAttributesDto": {
      "sectionId": 789,
      "managerGroupId": 170305,
      "costCentre": 1001,
      "managerId": 1234
    },
    "unitAttributesDto": {
      "unitId": 170305,
      "address": {
        "country": "SE",
        "address": "123 Main Street",
        "zipCode": "11120",
        "city": "Stockholm",
        "municipality": "Stockholm Municipality",
        "timeZone": "Europe/Stockholm"
      },
      "costCentre": 1001,
      "managerId": 1234,
      "currency": "SEK",
      "publishedTo": "2026-04-20",
      "shiftRules": {
        "maxHoursPerDay": 8,
        "maxHoursPerWeek": 40,
        "minRest": 11,
        "numberOfBreaks": 1
      },
      "shiftRulesDto": {
        "maxHoursPerDay": 8,
        "maxHoursPerWeek": 40,
        "minRest": 11,
        "numberOfBreaks": 1
      }
    }
  }
]

Changes

Changed in 2 of the 3 revisions of this API.4

Sep 1, 2026df5d81eb4c362See the full diff
- ○
  the security scope groups:read was added to the endpoint's security scheme OAuth2ClientCredentials
  api-security-scope-added
- ○
  the security scope account:read was removed from the endpoint's security scheme OAuth2ClientCredentials
  api-security-scope-removed
Aug 13, 202670a12bbb88c92See the full diff
- ○
  the endpoint scheme security OAuth2ClientCredentials was added to the API
  api-security-added
- ○
  the endpoint scheme security OAuth2ClientCredentials was added to the API
  api-security-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history