List all descendant groups

GET

/api/v4/groups/{id}/descendant_groups

Lists all descendant groups for a specified group.

Authorizations

http
oauth2

Parameters

Path Parameters

required

string

The ID of a group

Query Parameters

statistics

boolean

nullable

Include project statistics

archived

boolean

nullable

Limit by archived status

skip_groups

Array<integer>

nullable

Array of group ids to exclude from list

all_available

boolean

nullable

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

visibility

string

nullable

Allowed values: private internal public

Limit by visibility

search

string

nullable

Search for a specific group

owned

boolean

nullable

Limit by owned by authenticated user

order_by

string

default: name nullable

Allowed values: name path id similarity

Order by name, path, id or similarity if searching

sort

string

default: asc nullable

Allowed values: asc desc

Sort by asc (ascending) or desc (descending)

min_access_level

integer

nullable

Allowed values: 10 15 20 25 30 40 50

Minimum access level of authenticated user

top_level_only

boolean

nullable

Only include top-level groups

marked_for_deletion_on

string format: date

nullable

Return groups that are marked for deletion on this date

active

boolean

nullable

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

repository_storage

string

nullable

Filter by repository storage used by the group

page

integer

default: 1 nullable

Current page number

Example

per_page

integer

default: 20 nullable

Number of items per page

Example

with_custom_attributes

boolean

nullable

Include custom attributes in the response

custom_attributes

Filter with custom attributes

object

Responses

200

application/json

object

integer format: int64

web_url

string

name

string

path

string

description

string

visibility

string

share_with_group_lock

boolean

require_two_factor_authentication

boolean

two_factor_grace_period

integer

project_creation_level

string

auto_devops_enabled

string

subgroup_creation_level

string

emails_disabled

boolean

emails_enabled

boolean

show_diff_preview_in_email

boolean

mentions_disabled

string

lfs_enabled

boolean

archived

boolean

math_rendering_limits_enabled

boolean

lock_math_rendering_limits_enabled

boolean

crm_enabled

boolean

resource_access_token_notify_inherited

boolean

lock_resource_access_token_notify_inherited

boolean

default_branch

string

default_branch_protection

integer

default_branch_protection_defaults

string

avatar_url

string

request_access_enabled

boolean

full_name

string

full_path

string

created_at

string

parent_id

string

organization_id

integer format: int64

shared_runners_setting

string

max_artifacts_size

integer

custom_attributes

object

key

string

value

string

statistics

string

marked_for_deletion_on

string

root_storage_statistics

object

build_artifacts_size

CI artifacts size in bytes.

integer

container_registry_size

Container registry size in bytes.

integer

container_registry_size_is_estimated

Indicates whether the deduplicated container registry size for the namespace is an estimated value or not.

boolean

dependency_proxy_size

Dependency Proxy sizes in bytes.

integer

lfs_objects_size

LFS objects size in bytes.

integer

packages_size

Packages size in bytes.

integer

pipeline_artifacts_size

CI pipeline artifacts size in bytes.

integer

repository_size

Git repository size in bytes.

integer

snippets_size

Snippets size in bytes.

integer

storage_size

Total storage in bytes.

integer

uploads_size

Uploads size in bytes.

integer

wiki_size

Wiki size in bytes.

integer

ldap_cn

string

ldap_access

string

ldap_group_links

object

string

group_access

integer

provider

string

filter

string

member_role_id

integer format: int64

saml_group_links

object

name

string

access_level

integer

member_role_id

integer format: int64

provider

string

file_template_project_id

string

wiki_access_level

string

repository_storage

string

duo_core_features_enabled

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

boolean

duo_features_enabled

string

lock_duo_features_enabled

string

auto_duo_code_review_enabled

string

web_based_commit_signing_enabled

string

allow_personal_snippets

string

duo_namespace_access_rules

string

built_in_project_templates_enabled

boolean

lock_built_in_project_templates_enabled

boolean

Example

{
  "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"
  }
}

400

Bad Request

404

Not Found