GIgitlab
groups

List all subgroups

Lists all subgroups for a specified group.

get/api/v4/groups/{id}/subgroups

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID of a group

Query parameters

statisticsboolean

Include project statistics

archivedboolean

Limit by archived status

skip_groupsinteger[]

Array of group ids to exclude from list

all_availableboolean

When true, returns all accessible groups. When false, returns only groups where the user is a member.

visibility'private' | 'internal' | 'public'

Limit by visibility

searchstring

Search for a specific group

ownedboolean

Limit by owned by authenticated user

order_by'name' | 'path' | 'id' | 'similarity'

Order by name, path, id or similarity if searching

sort'asc' | 'desc'

Sort by asc (ascending) or desc (descending)

min_access_level10 | 15 | 20 | 25 | 30 | 40 | 50

Minimum access level of authenticated user

top_level_onlyboolean

Only include top-level groups

marked_for_deletion_onstring date

Return groups that are marked for deletion on this date

activeboolean

Limit by groups that are not archived and not marked for deletion

repository_storagestring

Filter by repository storage used by the group

pageinteger

Current page number

per_pageinteger

Number of items per page

with_custom_attributesboolean

Include custom attributes in the response

Response

List all subgroups

idinteger required
web_urlstring required
namestring required
pathstring required
descriptionstring required
visibilitystring required
share_with_group_lockboolean required
require_two_factor_authenticationboolean required
two_factor_grace_periodinteger required
project_creation_levelstring required
auto_devops_enabledstring required
subgroup_creation_levelstring required
emails_disabledboolean required
emails_enabledboolean required
show_diff_preview_in_emailboolean required
mentions_disabledstring required
lfs_enabledboolean required
archivedboolean required
math_rendering_limits_enabledboolean required
lock_math_rendering_limits_enabledboolean required
crm_enabledboolean required
resource_access_token_notify_inheritedboolean required
lock_resource_access_token_notify_inheritedboolean required
default_branchstring required
default_branch_protectioninteger required
default_branch_protection_defaultsstring required
avatar_urlstring required
request_access_enabledboolean required
full_namestring required
full_pathstring required
created_atstring required
parent_idstring required
organization_idinteger required
shared_runners_settingstring required
max_artifacts_sizeinteger required
marked_for_deletion_onstring required
ldap_cnstring required
ldap_accessstring required
file_template_project_idstring
wiki_access_levelstring required
repository_storagestring
duo_core_features_enabledboolean

[Experimental] Indicates whether GitLab Duo Core features are enabled for the group

duo_features_enabledstring
lock_duo_features_enabledstring
auto_duo_code_review_enabledstring
web_based_commit_signing_enabledstring
allow_personal_snippetsstring
duo_namespace_access_rulesstring
built_in_project_templates_enabledboolean
lock_built_in_project_templates_enabledboolean

Example response

[
  {
    "web_url": "http://gitlab.example.com/groups/diaspora",
    "name": "Diaspora",
    "custom_attributes": {
      "key": "foo",
      "value": "bar"
    },
    "ldap_group_links": {
      "cn": "ldap-group-1",
      "group_access": 10,
      "provider": "ldapmain",
      "filter": "id >= 500",
      "member_role_id": 12
    },
    "saml_group_links": {
      "name": "saml-group-1",
      "access_level": 40,
      "member_role_id": 12,
      "provider": "saml"
    }
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.