Groups

Use this API to view and manage groups and the resources they contain, including:

Group settings, members, and security settings.
Group issues and issue statistics.
Markdown uploads referenced in epics or wiki pages.
Bulk reassignment of placeholder users after an import.

Endpoint responses might vary based on the permissions of the authenticated user in the group. If a user isn’t a member of a private group, requests to that group return a 404 Not Found status code.

For project members, use the project members API.

List all groups

GET /api/v4/groups

Lists all visible groups for the authenticated user. Unauthenticated requests return only public groups.

Parameters

Name	Type	Description
`statistics` Query	Boolean	Include project statistics Default: `false`
`archived` Query	Boolean	Limit by archived status
`skip_groups` Query	Array of integers	Array of group ids to exclude from list
`all_available` Query	Boolean	When `true`, returns all accessible groups. When `false`, returns only groups where the user is a member
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Search for a specific group
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`order_by` Query	String	Order by name, path, id or similarity if searching Allowed values: `name`, `path`, `id`, `similarity` Default: `name`
`sort` Query	String	Sort by asc (ascending) or desc (descending) Allowed values: `asc`, `desc` Default: `asc`
`min_access_level` Query	Integer	Minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`top_level_only` Query	Boolean	Only include top-level groups
`marked_for_deletion_on` Query	String (date)	Return groups that are marked for deletion on this date
`active` Query	Boolean	Limit by groups that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—

Create a group

POST /api/v4/groups

Creates a project group. Available only for users who can create groups.

Request body (multipart/form-data)

Property	Type	Description
`auto_devops_enabled`	Boolean	Default to Auto DevOps pipeline for all projects within this group
`avatar`	String (binary)	Avatar image for the group
`crm_enabled`	Boolean	Enable Customer Relations Management for this group
`default_branch`	String	The default branch of group’s projects Example: `main`
`default_branch_protection`	Integer	Determine if developers can push to default branch Allowed values: `0`, `3`, `1`, `2`, `4`
`default_branch_protection_defaults`	Object	Determine if developers can push to default branch
`default_branch_protection_defaults.allow_force_push`	Boolean	Allow force push for all users with push access
`default_branch_protection_defaults.allowed_to_merge`	Array of objects	An array of access levels allowed to merge
`default_branch_protection_defaults.allowed_to_merge[].access_level` Required	Integer	A valid access level Allowed values: `30`, `40`, `60`, `0`
`default_branch_protection_defaults.allowed_to_push`	Array of objects	An array of access levels allowed to push
`default_branch_protection_defaults.allowed_to_push[].access_level` Required	Integer	A valid access level Allowed values: `30`, `40`, `60`, `0`
`default_branch_protection_defaults.code_owner_approval_required`	Boolean	Require approval from code owners
`default_branch_protection_defaults.developer_can_initial_push`	Boolean	Allow developers to initial push
`description`	String	The description of the group
`emails_disabled`	Boolean	(Deprecated) Disable email notifications. Use: emails_enabled
`emails_enabled`	Boolean	Enable email notifications
`enabled_git_access_protocol`	String	Allow only the selected protocols to be used for Git access Allowed values: `ssh`, `http`, `all`
`lfs_enabled`	Boolean	Enable/disable LFS for the projects in this group
`lock_resource_access_token_notify_inherited`	Boolean	Prevent subgroups from overriding the access token expiry notification setting
`mentions_disabled`	Boolean	Disable a group from getting mentioned
`name` Required	String	The name of the group
`organization_id`	Integer	The organization id for the group
`parent_id`	Integer	The parent group id for creating nested group
`path` Required	String	The path of the group
`project_creation_level`	String	Determine if developers can create projects in the group Allowed values: `noone`, `owner`, `maintainer`, `developer`, `administrator`
`request_access_enabled`	Boolean	Allow users to request member access
`require_two_factor_authentication`	Boolean	Require all users in this group to setup Two-factor authentication
`resource_access_token_notify_inherited`	Boolean	Send access token expiry notifications to all inherited members of the group
`share_with_group_lock`	Boolean	Prevent sharing a project with another group within this group
`show_diff_preview_in_email`	Boolean	Include the code diff preview in merge request notification emails
`subgroup_creation_level`	String	Allowed to create subgroups Allowed values: `owner`, `maintainer`
`two_factor_grace_period`	Integer	Time before Two-factor authentication is enforced
`visibility`	String	The visibility of the group Allowed values: `private`, `internal`, `public`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesGroup
`400`	Bad Request	—

Retrieve a group

GET /api/v4/groups/{id}

Retrieves a specified group by ID or path.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes
`with_projects` Query	Boolean	Omit project details Default: `true`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroupDetail
`400`	Bad Request	—
`404`	Not Found	—

Update group attributes

PUT /api/v4/groups/{id}

Updates the attributes for a specified group. You must be an administrator or have the Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Request body (multipart/form-data)

Property	Type	Description
`auto_devops_enabled`	Boolean	Default to Auto DevOps pipeline for all projects within this group
`avatar`	String (binary)	Avatar image for the group
`crm_enabled`	Boolean	Enable Customer Relations Management for this group
`default_branch`	String	The default branch of group’s projects Example: `main`
`default_branch_protection`	Integer	Determine if developers can push to default branch Allowed values: `0`, `3`, `1`, `2`, `4`
`default_branch_protection_defaults`	Object	Determine if developers can push to default branch
`default_branch_protection_defaults.allow_force_push`	Boolean	Allow force push for all users with push access
`default_branch_protection_defaults.allowed_to_merge`	Array of objects	An array of access levels allowed to merge
`default_branch_protection_defaults.allowed_to_merge[].access_level` Required	Integer	A valid access level Allowed values: `30`, `40`, `60`, `0`
`default_branch_protection_defaults.allowed_to_push`	Array of objects	An array of access levels allowed to push
`default_branch_protection_defaults.allowed_to_push[].access_level` Required	Integer	A valid access level Allowed values: `30`, `40`, `60`, `0`
`default_branch_protection_defaults.code_owner_approval_required`	Boolean	Require approval from code owners
`default_branch_protection_defaults.developer_can_initial_push`	Boolean	Allow developers to initial push
`description`	String	The description of the group
`emails_disabled`	Boolean	(Deprecated) Disable email notifications. Use: emails_enabled
`emails_enabled`	Boolean	Enable email notifications
`enabled_git_access_protocol`	String	Allow only the selected protocols to be used for Git access Allowed values: `ssh`, `http`, `all`
`lfs_enabled`	Boolean	Enable/disable LFS for the projects in this group
`lock_math_rendering_limits_enabled`	Boolean	Indicates if math rendering limits are locked for all descendent groups
`lock_resource_access_token_notify_inherited`	Boolean	Prevent subgroups from overriding the access token expiry notification setting
`math_rendering_limits_enabled`	Boolean	Indicates if math rendering limits are used for this group
`max_artifacts_size`	Integer	Set the maximum file size for each job’s artifacts
`mentions_disabled`	Boolean	Disable a group from getting mentioned
`name`	String	The name of the group
`path`	String	The path of the group
`prevent_sharing_groups_outside_hierarchy`	Boolean	Prevent sharing groups within this namespace with any groups outside the namespace. Only available on top-level groups
`project_creation_level`	String	Determine if developers can create projects in the group Allowed values: `noone`, `owner`, `maintainer`, `developer`, `administrator`
`request_access_enabled`	Boolean	Allow users to request member access
`require_two_factor_authentication`	Boolean	Require all users in this group to setup Two-factor authentication
`resource_access_token_notify_inherited`	Boolean	Send access token expiry notifications to all inherited members of the group
`share_with_group_lock`	Boolean	Prevent sharing a project with another group within this group
`shared_runners_setting`	String	Enable/disable shared runners for the group and its subgroups and projects Allowed values: `disabled_and_unoverridable`, `disabled_and_overridable`, `enabled`
`show_diff_preview_in_email`	Boolean	Include the code diff preview in merge request notification emails
`step_up_auth_required_oauth_provider`	String	OAuth provider required for step-up authentication. Pass empty string to disable
`subgroup_creation_level`	String	Allowed to create subgroups Allowed values: `owner`, `maintainer`
`two_factor_grace_period`	Integer	Time before Two-factor authentication is enforced
`visibility`	String	The visibility of the group Allowed values: `private`, `internal`, `public`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

Schedule a group for deletion

DELETE /api/v4/groups/{id}

Schedules a group for deletion. Groups are deleted at the end of the retention period (30 days by default). Use the permanently_remove param to override the retention period.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`202`	Accepted	—
`400`	Bad Request	—
`404`	Not Found	—

Archive a group

POST /api/v4/groups/{id}/archive

Archives a specified group. You must be an administrator or have the Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

List all descendant groups

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

Lists all descendant groups for a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`statistics` Query	Boolean	Include project statistics Default: `false`
`archived` Query	Boolean	Limit by archived status
`skip_groups` Query	Array of integers	Array of group ids to exclude from list
`all_available` Query	Boolean	When `true`, returns all accessible groups. When `false`, returns only groups where the user is a member
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Search for a specific group
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`order_by` Query	String	Order by name, path, id or similarity if searching Allowed values: `name`, `path`, `id`, `similarity` Default: `name`
`sort` Query	String	Sort by asc (ascending) or desc (descending) Allowed values: `asc`, `desc` Default: `asc`
`min_access_level` Query	Integer	Minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`top_level_only` Query	Boolean	Only include top-level groups
`marked_for_deletion_on` Query	String (date)	Return groups that are marked for deletion on this date
`active` Query	Boolean	Limit by groups that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

List all shared groups

GET /api/v4/groups/{id}/groups/shared

Lists all groups shared with a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`skip_groups` Query	Array of integers	Array of group ids to exclude from list
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Search for a specific group
`min_access_level` Query	Integer	Minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`order_by` Query	String	Order by name, path, id or similarity if searching Allowed values: `name`, `path`, `id`, `similarity` Default: `name`
`sort` Query	String	Sort by asc (ascending) or desc (descending) Allowed values: `asc`, `desc` Default: `asc`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

List all invited groups

GET /api/v4/groups/{id}/invited_groups

Lists all groups invited to a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`relation` Query	Array of strings	Include group relations
`search` Query	String	Search for a specific group
`min_access_level` Query	Integer	Minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

List all issues for a group

GET /api/v4/groups/{id}/issues

Lists all issues for a specified group. If the group is private, you must provide credentials to authorize. In most cases, you should authenticate with a personal access token.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`with_labels_details` Query	Boolean	Return titles of labels and other details Default: `false`
`state` Query	String	Return opened, closed, or all issues Allowed values: `opened`, `closed`, `all` Default: `all`
`closed_by_id` Query	Integer	Return issues which were closed by the user with the given ID
`order_by` Query	String	Return issues ordered by `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, or `updated_at` fields Allowed values: `created_at`, `due_date`, `label_priority`, `milestone_due`, `popularity`, `priority`, `relative_position`, `title`, `updated_at` Default: `created_at`
`sort` Query	String	Return issues sorted in `asc` or `desc` order Allowed values: `asc`, `desc` Default: `desc`
`due_date` Query	String	Return issues that have no due date (`0`), or whose due date is this week, this month, between two weeks ago and next month, or which are overdue. Accepts: `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, `0` Allowed values: `0`, `any`, `today`, `tomorrow`, `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`, ``
`issue_type` Query	String	The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket Allowed values: `issue`, `incident`, `test_case`, `requirement`, `task`, `ticket`
`labels` Query	Array of strings	Comma-separated list of label names
`milestone` Query	String	Milestone title. Mutually exclusive with `milestone_id`
`milestone_id` Query	String	Return issues assigned to milestones with the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `milestone` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`iids` Query	Array of integers	The IID array of issues
`search` Query	String	Search issues for text present in the title, description, or any combination of these
`in` Query	String	`title`, `description`, or a string joining them with comma
`author_id` Query	Integer	Return issues which are authored by the user with the given ID. Mutually exclusive with `author_username`
`author_username` Query	String	Return issues which are authored by the user with the given username. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Return issues which are assigned to the user with the given ID. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Return issues which are assigned to the user with the given username. Mutually exclusive with `assignee_id`
`created_after` Query	String (date-time)	Return issues created after the specified time
`created_before` Query	String (date-time)	Return issues created before the specified time
`updated_after` Query	String (date-time)	Return issues updated after the specified time
`updated_before` Query	String (date-time)	Return issues updated before the specified time
`not` Query	Object	Filters by the specified parameters
`not[labels]` Query	Array of strings	Comma-separated list of label names
`not[milestone]` Query	String	Milestone title. Mutually exclusive with `not[milestone_id]`
`not[milestone_id]` Query	String	Return issues assigned to milestones without the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `not[milestone]` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`not[iids]` Query	Array of integers	The IID array of issues
`not[author_id]` Query	Integer	Return issues which are not authored by the user with the given ID. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	Return issues which are not authored by the user with the given username. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer	Return issues which are not assigned to the user with the given ID. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	Return issues which are not assigned to the user with the given username. Mutually exclusive with `not[assignee_id]`
`scope` Query	String	Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `all`
`my_reaction_emoji` Query	String	Return issues reacted by the authenticated user by the given emoji
`confidential` Query	Boolean	Filter confidential or public issues
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`non_archived` Query	Boolean	Return issues from non archived projects Default: `true`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIssue
`400`	Bad Request	—
`404`	Not Found	—

Retrieve issues statistics for a group

GET /api/v4/groups/{id}/issues_statistics

Retrieves statistics for issues in a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`labels` Query	Array of strings	Comma-separated list of label names
`milestone` Query	String	Milestone title. Mutually exclusive with `milestone_id`
`milestone_id` Query	String	Return issues assigned to milestones with the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `milestone` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`iids` Query	Array of integers	The IID array of issues
`search` Query	String	Search issues for text present in the title, description, or any combination of these
`in` Query	String	`title`, `description`, or a string joining them with comma
`author_id` Query	Integer	Return issues which are authored by the user with the given ID. Mutually exclusive with `author_username`
`author_username` Query	String	Return issues which are authored by the user with the given username. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Return issues which are assigned to the user with the given ID. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Return issues which are assigned to the user with the given username. Mutually exclusive with `assignee_id`
`created_after` Query	String (date-time)	Return issues created after the specified time
`created_before` Query	String (date-time)	Return issues created before the specified time
`updated_after` Query	String (date-time)	Return issues updated after the specified time
`updated_before` Query	String (date-time)	Return issues updated before the specified time
`not` Query	Object	Filters by the specified parameters
`not[labels]` Query	Array of strings	Comma-separated list of label names
`not[milestone]` Query	String	Milestone title. Mutually exclusive with `not[milestone_id]`
`not[milestone_id]` Query	String	Return issues assigned to milestones without the specified timebox value (“Any”, “None”, “Upcoming” or “Started”). Mutually exclusive with `not[milestone]` Allowed values: `Any`, `None`, `Upcoming`, `Started`
`not[iids]` Query	Array of integers	The IID array of issues
`not[author_id]` Query	Integer	Return issues which are not authored by the user with the given ID. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	Return issues which are not authored by the user with the given username. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer	Return issues which are not assigned to the user with the given ID. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	Return issues which are not assigned to the user with the given username. Mutually exclusive with `not[assignee_id]`
`scope` Query	String	Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `all`
`my_reaction_emoji` Query	String	Return issues reacted by the authenticated user by the given emoji
`confidential` Query	Boolean	Filter confidential or public issues

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Retrieve pending reassignments

GET /api/v4/groups/{id}/placeholder_reassignments

Retrieves a CSV file with a list of pending reassignments. This feature was introduced in GitLab 17.10.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`200`	OK	String (`text/csv`)
`400`	Bad Request	—
`404`	Not Found	—

Reassign placeholders

POST /api/v4/groups/{id}/placeholder_reassignments

Reassigns placeholder users with an uploaded CSV file.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Request body (multipart/form-data)

Property	Type	Description
`file` Required	String (binary)	The CSV file containing the reassignments

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Workhorse authorization for the reassignment CSV file

POST /api/v4/groups/{id}/placeholder_reassignments/authorize

Authorizes Workhorse to handle CSV file uploads for placeholder reassignments. This feature was introduced in GitLab 17.10

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

List all projects in a group

GET /api/v4/groups/{id}/projects

Lists all projects in a specified group accessible to the authenticated user. Unauthenticated requests return only public projects with a limited subset of attributes.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`active` Query	Boolean	Limit by projects that are not archived and not marked for deletion
`archived` Query	Boolean	Limit by archived status
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Return list of authorized projects matching the search criteria
`order_by` Query	String	Return projects ordered by field Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `similarity`, `star_count` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`starred` Query	Boolean	Limit by starred status Default: `false`
`with_issues_enabled` Query	Boolean	Limit by enabled issues feature Default: `false`
`with_merge_requests_enabled` Query	Boolean	Limit by enabled merge requests feature Default: `false`
`with_shared` Query	Boolean	Include projects shared to this group Default: `true`
`include_subgroups` Query	Boolean	Includes projects in subgroups of this group Default: `false`
`include_ancestor_groups` Query	Boolean	Includes projects in ancestors of this group Default: `false`
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user on projects Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProject
`400`	Bad Request	—
`404`	Not Found	—

List all shared projects

GET /api/v4/groups/{id}/projects/shared

Lists all projects shared with a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`archived` Query	Boolean	Limit by archived status
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Return list of authorized projects matching the search criteria
`order_by` Query	String	Return projects ordered by field Allowed values: `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, `star_count` Default: `created_at`
`sort` Query	String	Return projects sorted in ascending and descending order Allowed values: `asc`, `desc` Default: `desc`
`simple` Query	Boolean	Return only the ID, URL, name, and path of each project Default: `false`
`starred` Query	Boolean	Limit by starred status Default: `false`
`with_issues_enabled` Query	Boolean	Limit by enabled issues feature Default: `false`
`with_merge_requests_enabled` Query	Boolean	Limit by enabled merge requests feature Default: `false`
`min_access_level` Query	Integer	Limit by minimum access level of authenticated user on projects Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesProject
`400`	Bad Request	—
`404`	Not Found	—

Transfer a project to a group

POST /api/v4/groups/{id}/projects/{project_id}

Transfers a specified project to another group. Administrators only.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`project_id` Path, required	String	The ID or path of the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesGroupDetail
`400`	Bad Request	—
`404`	Not Found	—

Restore a group

POST /api/v4/groups/{id}/restore

Restores a specified group that was previously scheduled for deletion. Can not restore groups outside of the retention period (30 days by default).

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

List all runners in a group

GET /api/v4/groups/{id}/runners

Lists all runners available in a specified group and any ancestor groups, including any allowed instance runners.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`type` Query	String	The type of runners to return Allowed values: `instance_type`, `group_type`, `project_type`
`paused` Query	Boolean	Whether to include only runners that are accepting or ignoring new jobs
`status` Query	String	The status of runners to return Allowed values: `active`, `paused`, `online`, `offline`, `never_contacted`, `stale`
`tag_list` Query	Array of strings	A list of runner tags Example: `["macos","shell"]`
`version_prefix` Query	String	The version prefix of runners to return Pattern: `(?<=^\|\n(?!$))[\d+.]+` Example: `15.1.`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiRunner
`400`	Scope contains invalid value	—
`403`	Forbidden	—
`404`	Not Found	—

Reset runner registration token

POST /api/v4/groups/{id}/runners/reset_registration_token

FE version

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiResetTokenResult
`400`	Bad Request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Group Not Found	—

Add a group to a group

POST /api/v4/groups/{id}/share

Adds a group to a group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Request body (application/json)

Property	Type	Description
`expires_at`	String (date)	Share expiration date
`group_access` Required	Integer	The group access level Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`group_id` Required	Integer	The ID of the group to share
`member_role_id`	Integer	The ID of the Member Role to be assigned to the group

Responses

Code	Description	Schema
`201`	Created	APIEntitiesGroupDetail
`400`	Bad Request	—
`404`	Not Found	—

Remove a group from a group

DELETE /api/v4/groups/{id}/share/{group_id}

Removes a group from a group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`group_id` Path, required	Integer	The ID of the shared group

Responses

Code	Description	Schema
`204`	Resource deleted	—
`400`	Bad Request	—
`404`	Not Found	—

Remove a shared project from a group

DELETE /api/v4/groups/{id}/shared_projects/{project_id}

Removes a shared project targeting this group. The group Owner can remove a shared project without access to the source project.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`project_id` Path, required	Integer	The ID of the shared project

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`403`	Forbidden	—
`404`	Not found	—

List all subgroups

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

Lists all subgroups for a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`statistics` Query	Boolean	Include project statistics Default: `false`
`archived` Query	Boolean	Limit by archived status
`skip_groups` Query	Array of integers	Array of group ids to exclude from list
`all_available` Query	Boolean	When `true`, returns all accessible groups. When `false`, returns only groups where the user is a member
`visibility` Query	String	Limit by visibility Allowed values: `private`, `internal`, `public`
`search` Query	String	Search for a specific group
`owned` Query	Boolean	Limit by owned by authenticated user Default: `false`
`order_by` Query	String	Order by name, path, id or similarity if searching Allowed values: `name`, `path`, `id`, `similarity` Default: `name`
`sort` Query	String	Sort by asc (ascending) or desc (descending) Allowed values: `asc`, `desc` Default: `asc`
`min_access_level` Query	Integer	Minimum access level of authenticated user Allowed values: `10`, `15`, `20`, `25`, `30`, `40`, `50`
`top_level_only` Query	Boolean	Only include top-level groups
`marked_for_deletion_on` Query	String (date)	Return groups that are marked for deletion on this date
`active` Query	Boolean	Limit by groups that are not archived and not marked for deletion
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`with_custom_attributes` Query	Boolean	Include custom attributes in the response Default: `false`
`custom_attributes` Query	Object	Filter with custom attributes

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

Transfer a group

POST /api/v4/groups/{id}/transfer

Transfers a group to another parent group or transforms a subgroup into a top-level group. You must be an administrator or have the Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Request body (application/json)

Property	Type	Description
`group_id`	Integer	The ID of the target group to which the group needs to be transferred to.If not provided, the source group will be promoted to a top-level group

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

List all transfer locations for a group

GET /api/v4/groups/{id}/transfer_locations

Lists all groups that a specified source group can be transferred to.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`search` Query	String	Return list of namespaces matching the search criteria
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

Transfer a group to an organization

POST /api/v4/groups/{id}/transfer_to_organization

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Request body (application/json)

Property	Type	Description
`organization_id` Required	Integer	The ID of the organization to transfer the group to

Responses

Code	Description	Schema
`201`	Created	APIEntitiesGroupDetail
`400`	Bad request	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Group or Organization not found	—
`422`	Unprocessable entity	—

Unarchive a group

POST /api/v4/groups/{id}/unarchive

Unarchives a specified group. You must be an administrator or have the Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not Found	—

List all uploads for a group

GET /api/v4/groups/{id}/uploads

Lists all uploads for a specified group sorted by created_at in descending order. You must have the Maintainer or Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMarkdownUploadAdmin
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Upload a file to a group

POST /api/v4/groups/{id}/uploads

Uploads a file to the specified group. Returns a markdown-formatted link to the file.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group

Request body (multipart/form-data)

Property	Type	Description
`file` Required	String (binary)	The file to upload

Responses

Code	Description	Schema
`201`	Created	APIEntitiesGroupUpload
`400`	Bad request	—
`404`	Not found	—

Workhorse authorize the file upload

POST /api/v4/groups/{id}/uploads/authorize

This feature was introduced in GitLab 19.0

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not found	—

Download an uploaded file by secret and filename

GET /api/v4/groups/{id}/uploads/{secret}/{filename}

Downloads an uploaded file with a specified secret and filename. You must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group
`secret` Path, required	String	The 32-character secret of a group upload
`filename` Path, required	String	The filename of a group upload

Responses

Code	Description	Schema
`200`	OK	String (binary) (`application/octet-stream`)
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Delete an uploaded file by secret and filename

DELETE /api/v4/groups/{id}/uploads/{secret}/{filename}

Deletes an uploaded file with a specified secret and filename. You must have the Maintainer or Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group
`secret` Path, required	String	The 32-character secret of a group upload
`filename` Path, required	String	The filename of a group upload

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

Download an uploaded file by ID

GET /api/v4/groups/{id}/uploads/{upload_id}

Downloads an uploaded file with a specified ID. You must have the Maintainer or Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group
`upload_id` Path, required	Integer	The ID of a group upload

Responses

Code	Description	Schema
`200`	OK	String (binary) (`application/octet-stream`)
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

Delete an uploaded file by ID

DELETE /api/v4/groups/{id}/uploads/{upload_id}

Deletes an uploaded file with a specified ID. You must have the Maintainer or Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the group
`upload_id` Path, required	Integer	The ID of a group upload

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`403`	Unauthenticated	—
`404`	Not found	—

Get the users list of a group

GET /api/v4/groups/{id}/users

Parameters

Name	Type	Description
`search` Query	String	Return list of users matching the search criteria Example: `user`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`id` Path, required	String or integer	The ID or URL-encoded path of the group Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserBasic
`400`	Bad Request	—
`403`	Unauthenticated	—
`404`	Not found	—

List all groups available to invite to a project

GET /api/v4/projects/{id}/share_locations

Lists all groups that can be invited to a project.

Parameters

Name	Type	Description
`id` Path, required	Integer	The id of the project
`search` Query	String	Return list of groups matching the search criteria

Responses

Code	Description	Schema
`200`	OK	APIEntitiesGroup
`400`	Bad Request	—
`404`	Not Found	—

Reset the runner registration token for the instance

POST /api/v4/runners/reset_registration_token

Resets the runner registration token for the GitLab instance.

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiResetTokenResult
`400`	Bad Request	—
`403`	Forbidden	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesBasicProjectDetails

Property	Type	Description
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`forks_count`	Integer	Example: `1`
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`repository_storage`	String	Example: `default`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`visibility`	String	Example: `public`
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`

APIEntitiesCiResetTokenResult

Property	Type	Description
`token`	String	—
`token_expires_at`	String	—

APIEntitiesCiRunner

Property	Type	Description
`active`	Boolean	Example: `true`
`created_at`	String (date-time)	Example: `2025-05-03T00:00:00.000Z`
`created_by`	APIEntitiesUserBasic	—
`description`	String	Example: `test-1-20150125`
`id`	Integer (int64)	Example: `8`
`ip_address`	String	Example: `127.0.0.1`
`is_shared`	Boolean	Example: `true`
`job_execution_status`	String	Allowed values: `active`, `idle` Example: `idle`
`name`	String	Example: `test`
`online`	Boolean	Example: `true`
`paused`	Boolean	Example: `false`
`runner_type`	String	Allowed values: `instance_type`, `group_type`, `project_type` Example: `instance_type`
`status`	String	Example: `online`

APIEntitiesContainerExpirationPolicy

Property	Type	Description
`cadence`	String	—
`enabled`	String	—
`keep_n`	String	—
`name_regex`	String	—
`name_regex_keep`	String	—
`next_run_at`	String	—
`older_than`	String	—

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesGroup

Property	Type	Description
`archived`	Boolean	—
`auto_devops_enabled`	String	—
`avatar_url`	String	—
`created_at`	String	—
`crm_enabled`	Boolean	—
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	—
`default_branch_protection`	Integer	—
`default_branch_protection_defaults`	String	—
`description`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`full_name`	String	—
`full_path`	String	—
`id`	Integer (int64)	—
`lfs_enabled`	Boolean	—
`lock_math_rendering_limits_enabled`	Boolean	—
`lock_resource_access_token_notify_inherited`	Boolean	—
`marked_for_deletion_on`	String	—
`math_rendering_limits_enabled`	Boolean	—
`max_artifacts_size`	Integer	—
`mentions_disabled`	String	—
`name`	String	Example: `Diaspora`
`organization_id`	Integer (int64)	—
`parent_id`	String	—
`path`	String	—
`project_creation_level`	String	—
`request_access_enabled`	Boolean	—
`require_two_factor_authentication`	Boolean	—
`resource_access_token_notify_inherited`	Boolean	—
`root_storage_statistics`	APIEntitiesNamespaceRootStorageStatistics	—
`share_with_group_lock`	Boolean	—
`shared_runners_setting`	String	—
`show_diff_preview_in_email`	Boolean	—
`statistics`	Object	—
`statistics.job_artifacts_size`	String	—
`statistics.lfs_objects_size`	String	—
`statistics.packages_size`	String	—
`statistics.pipeline_artifacts_size`	String	—
`statistics.repository_size`	String	—
`statistics.snippets_size`	String	—
`statistics.storage_size`	String	—
`statistics.uploads_size`	String	—
`statistics.wiki_size`	String	—
`subgroup_creation_level`	String	—
`two_factor_grace_period`	Integer	—
`visibility`	String	—
`web_url`	String	Example: `http://gitlab.example.com/groups/diaspora`

APIEntitiesGroupDetail

Property	Type	Description
`archived`	Boolean	—
`auto_devops_enabled`	String	—
`avatar_url`	String	—
`created_at`	String	—
`crm_enabled`	Boolean	—
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	—
`default_branch_protection`	Integer	—
`default_branch_protection_defaults`	String	—
`description`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`enabled_git_access_protocol`	String	Example: `ssh`
`full_name`	String	—
`full_path`	String	—
`id`	Integer (int64)	—
`lfs_enabled`	Boolean	—
`lock_math_rendering_limits_enabled`	Boolean	—
`lock_resource_access_token_notify_inherited`	Boolean	—
`marked_for_deletion_on`	String	—
`math_rendering_limits_enabled`	Boolean	—
`max_artifacts_size`	Integer	—
`mentions_disabled`	String	—
`name`	String	Example: `Diaspora`
`organization_id`	Integer (int64)	—
`parent_id`	String	—
`path`	String	—
`prevent_sharing_groups_outside_hierarchy`	Boolean	—
`project_creation_level`	String	—
`projects`	APIEntitiesProject	—
`request_access_enabled`	Boolean	—
`require_two_factor_authentication`	Boolean	—
`resource_access_token_notify_inherited`	Boolean	—
`root_storage_statistics`	APIEntitiesNamespaceRootStorageStatistics	—
`runners_token`	String	Example: `b8bc4a7a29eb76ea83cf79e4908c2b`
`share_with_group_lock`	Boolean	—
`shared_projects`	APIEntitiesProject	—
`shared_runners_setting`	String	—
`shared_with_groups`	Array of objects	—
`show_diff_preview_in_email`	Boolean	—
`statistics`	Object	—
`statistics.job_artifacts_size`	String	—
`statistics.lfs_objects_size`	String	—
`statistics.packages_size`	String	—
`statistics.pipeline_artifacts_size`	String	—
`statistics.repository_size`	String	—
`statistics.snippets_size`	String	—
`statistics.storage_size`	String	—
`statistics.uploads_size`	String	—
`statistics.wiki_size`	String	—
`step_up_auth_required_oauth_provider`	String	OAuth provider required for step-up authentication
`subgroup_creation_level`	String	—
`two_factor_grace_period`	Integer	—
`visibility`	String	—
`web_url`	String	Example: `http://gitlab.example.com/groups/diaspora`

APIEntitiesGroupUpload

Property	Type	Description
`alt`	String	The name of the file
`full_path`	String	The full path to the file
`id`	Integer (int64)	The ID of the file
`markdown`	String	A markdown-formatted link to the file
`url`	String	The URL to access the file

APIEntitiesIssuableReferences

Property	Type	Description
`full`	String	Example: `test&6`
`relative`	String	Example: `&6`
`short`	String	Example: `&6`

APIEntitiesIssuableTimeStats

Property	Type	Description
`human_time_estimate`	String	Example: `3h 30m`
`human_total_time_spent`	String	Example: `1h`
`time_estimate`	Integer	Example: `12600`
`total_time_spent`	Integer	Example: `3600`

APIEntitiesIssue

Property	Type	Description
`_links`	Object	—
`_links.award_emoji`	String	Example: `http://example.com/api/v4/projects/1/issues/2/award_emoji`
`_links.closed_as_duplicate_of`	String	Example: `http://example.com/api/v4/projects/1/issues/75`
`_links.notes`	String	Example: `http://example.com/api/v4/projects/1/issues/2/notes`
`_links.project`	String	Example: `http://example.com/api/v4/projects/1`
`_links.self`	String	Example: `http://example.com/api/v4/projects/1/issues/2`
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`closed_at`	String (date-time)	Example: `2022-11-15T08:30:55.232Z`
`closed_by`	APIEntitiesUserBasic	—
`confidential`	Boolean	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`discussion_locked`	Boolean	—
`downvotes`	Integer	—
`due_date`	String (date)	Example: `2022-11-20`
`has_tasks`	Boolean	Example: `true`
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	Example: `false`
`imported_from`	String	Example: `github`
`issue_type`	String	Example: `issue`
`labels`	Array of strings	Example: `["bug"]`
`merge_requests_count`	Integer	—
`milestone`	APIEntitiesMilestone	—
`moved_to_id`	Integer (int64)	Example: `1`
`project_id`	Integer (int64)	Example: `4`
`references`	APIEntitiesIssuableReferences	—
`service_desk_reply_to`	String	Example: `user@example.com`
`severity`	String	One of [“UNKNOWN”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL”]
`start_date`	String (date)	Example: `2022-11-18`
`state`	String	Example: `closed`
`subscribed`	Boolean	Example: `false`
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`task_status`	String	Example: `2 of 4 tasks completed`
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`type`	String	One of [“ISSUE”, “INCIDENT”, “TEST_CASE”, “REQUIREMENT”, “TASK”, “TICKET”] Example: `ISSUE`
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `http://example.com/example/example/issues/14`

APIEntitiesLicenseBasic

Property	Type	Description
`html_url`	String	Example: `http://choosealicense.com/licenses/gpl-3.0`
`key`	String	Example: `gpl-3.0`
`name`	String	Example: `GNU General Public License v3.0`
`nickname`	String	Example: `GNU GPLv3`
`source_url`	String	—

APIEntitiesMarkdownUploadAdmin

Property	Type	Description
`created_at`	String (date-time)	Example: `2012-06-28T10:52:04Z`
`filename`	String	Example: `image.png`
`id`	Integer (int64)	Example: `1`
`size`	Integer	Example: `1024`
`uploaded_by`	APIEntitiesUserSafe	—

APIEntitiesMilestone

Property	Type	Description
`created_at`	String	—
`description`	String	—
`due_date`	String	—
`expired`	Boolean	—
`group_id`	String	—
`id`	Integer (int64)	—
`iid`	Integer (int64)	—
`project_id`	Integer (int64)	—
`start_date`	String	—
`state`	String	—
`title`	String	—
`updated_at`	String	—
`web_url`	String	—

APIEntitiesNamespaceBasic

Property	Type	Description
`avatar_url`	String	Example: `https://example.com/avatar/12345`
`full_path`	String	Example: `group/my_project`
`id`	Integer (int64)	Example: `2`
`kind`	String	Example: `project`
`name`	String	Example: `project`
`parent_id`	Integer (int64)	Example: `1`
`path`	String	Example: `my_project`
`web_url`	String	Example: `https://example.com/group/my_project`

APIEntitiesNamespaceRootStorageStatistics

Property	Type	Description
`build_artifacts_size`	Integer	CI artifacts size in bytes
`container_registry_size`	Integer	container registry size in bytes
`container_registry_size_is_estimated`	Boolean	Indicates whether the deduplicated container registry size for the namespace is an estimated value or not
`dependency_proxy_size`	Integer	Dependency Proxy sizes in bytes
`lfs_objects_size`	Integer	LFS objects size in bytes
`packages_size`	Integer	Packages size in bytes
`pipeline_artifacts_size`	Integer	CI pipeline artifacts size in bytes
`repository_size`	Integer	Git repository size in bytes
`snippets_size`	Integer	Snippets size in bytes
`storage_size`	Integer	Total storage in bytes
`uploads_size`	Integer	Uploads size in bytes
`wiki_size`	Integer	Wiki size in bytes

APIEntitiesProject

Property	Type	Description
`_links`	Object	—
`_links.cluster_agents`	String	Example: `https://gitlab.example.com/api/v4/projects/4/cluster_agents`
`_links.events`	String	Example: `https://gitlab.example.com/api/v4/projects/4/events`
`_links.issues`	String	Example: `https://gitlab.example.com/api/v4/projects/4/issues`
`_links.labels`	String	Example: `https://gitlab.example.com/api/v4/projects/4/labels`
`_links.members`	String	Example: `https://gitlab.example.com/api/v4/projects/4/members`
`_links.merge_requests`	String	Example: `https://gitlab.example.com/api/v4/projects/4/merge_requests`
`_links.repo_branches`	String	Example: `https://gitlab.example.com/api/v4/projects/4/repository/branches`
`_links.self`	String	Example: `https://gitlab.example.com/api/v4/projects/4`
`allow_merge_on_skipped_pipeline`	Boolean	—
`allow_pipeline_trigger_approve_deployment`	Boolean	—
`analytics_access_level`	String	Example: `enabled`
`archived`	Boolean	—
`auto_cancel_pending_pipelines`	String	Example: `enabled`
`auto_devops_deploy_strategy`	String	Example: `continuous`
`auto_devops_enabled`	Boolean	—
`autoclose_referenced_issues`	Boolean	—
`automatic_rebase_enabled`	Boolean	—
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`build_git_strategy`	String	Example: `fetch`
`build_timeout`	Integer	Example: `3600`
`builds_access_level`	String	Example: `enabled`
`can_create_merge_request_in`	Boolean	—
`ci_allow_fork_pipelines_to_run_in_parent_project`	Boolean	—
`ci_config_path`	String	Example: ``
`ci_default_git_depth`	Integer	Example: `20`
`ci_delete_pipelines_in_seconds`	Integer	Example: `86400`
`ci_display_pipeline_variables`	Boolean	—
`ci_forward_deployment_enabled`	Boolean	—
`ci_forward_deployment_rollback_allowed`	Boolean	—
`ci_id_token_sub_claim_components`	Array of strings	—
`ci_job_token_scope_enabled`	Boolean	—
`ci_pipeline_variables_minimum_override_role`	String	—
`ci_push_repository_for_job_token_allowed`	Boolean	—
`ci_separated_caches`	Boolean	—
`ci_skip_branch_pipelines_for_mrs`	Boolean	—
`container_expiration_policy`	APIEntitiesContainerExpirationPolicy	—
`container_registry_access_level`	String	Example: `enabled`
`container_registry_enabled`	Boolean	—
`container_registry_image_prefix`	String	Example: `registry.gitlab.example.com/gitlab/gitlab-client`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`creator_id`	Integer (int64)	Example: `1`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`description_html`	String	—
`emails_disabled`	Boolean	—
`emails_enabled`	Boolean	—
`empty_repo`	Boolean	—
`enforce_auth_checks_on_uploads`	Boolean	—
`environments_access_level`	String	Example: `enabled`
`fe_project_setting_attributes`	Object	—
`feature_flags_access_level`	String	Example: `enabled`
`forked_from_project`	APIEntitiesBasicProjectDetails	—
`forking_access_level`	String	Example: `enabled`
`forks_count`	Integer	Example: `1`
`group_runners_enabled`	Boolean	—
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`import_error`	String	Example: `Import error`
`import_status`	String	Example: `none`
`import_type`	String	Example: `git`
`import_url`	String	Example: `https://gitlab.com/gitlab/gitlab.git`
`infrastructure_access_level`	String	Example: `enabled`
`issue_branch_template`	String	Example: `%(title)`
`issues_access_level`	String	Example: `enabled`
`issues_enabled`	Boolean	—
`jobs_enabled`	Boolean	—
`keep_latest_artifact`	Boolean	—
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`lfs_enabled`	Boolean	—
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`marked_for_deletion_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`marked_for_deletion_on`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`max_artifacts_size`	Integer	—
`max_pipelines_per_merge_train`	Integer	—
`merge_commit_template`	String	Example: `%(title)`
`merge_method`	String	Example: `merge`
`merge_pipelines_enabled`	Boolean	—
`merge_request_title_regex`	String	—
`merge_request_title_regex_description`	String	—
`merge_requests_access_level`	String	Example: `enabled`
`merge_requests_enabled`	Boolean	—
`merge_train_enforced`	Boolean	—
`merge_trains_enabled`	Boolean	—
`merge_trains_skip_train_allowed`	Boolean	—
`model_experiments_access_level`	String	Example: `enabled`
`model_registry_access_level`	String	Example: `enabled`
`monitor_access_level`	String	Example: `enabled`
`mr_default_target_self`	Boolean	—
`mr_default_title_template`	String	Example: `%(source_branch)`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`only_allow_merge_if_all_discussions_are_resolved`	Boolean	—
`only_allow_merge_if_pipeline_succeeds`	Boolean	—
`open_issues_count`	Integer	Example: `1`
`owner`	APIEntitiesUserBasic	—
`package_registry_access_level`	String	Example: `enabled`
`packages_enabled`	Boolean	—
`pages_access_level`	String	Example: `enabled`
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`printing_merge_request_link_enabled`	Boolean	—
`protect_merge_request_pipelines`	Boolean	—
`public_jobs`	Boolean	—
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`releases_access_level`	String	Example: `enabled`
`remove_source_branch_after_merge`	Boolean	—
`repository_access_level`	String	Example: `enabled`
`repository_object_format`	String	Example: `sha1`
`repository_storage`	String	Example: `default`
`request_access_enabled`	Boolean	—
`resolve_outdated_diff_discussions`	Boolean	—
`resource_group_default_process_mode`	String	Example: `unordered`
`restrict_user_defined_variables`	Boolean	—
`runner_token_expiration_interval`	Integer	Example: `3600`
`runners_token`	String	Example: `b8547b1dc37721d05889db52fa2f02`
`security_and_compliance_access_level`	String	Example: `enabled`
`service_desk_address`	String	Example: `address@example.com`
`service_desk_enabled`	Boolean	—
`shared_runners_enabled`	Boolean	—
`shared_with_groups`	Array of objects	—
`show_diff_preview_in_email`	Boolean	—
`snippets_access_level`	String	Example: `enabled`
`snippets_enabled`	Boolean	—
`squash_commit_template`	String	Example: `%(source_branch)`
`squash_option`	String	Example: `default_off`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`statistics`	APIEntitiesProjectStatistics	—
`suggestion_commit_message`	String	Example: `Suggestion message`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`updated_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`visibility`	String	Example: `public`
`warn_about_potentially_unwanted_characters`	Boolean	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`
`wiki_access_level`	String	Example: `enabled`
`wiki_enabled`	Boolean	—

APIEntitiesProjectStatistics

Property	Type	Description
`commit_count`	Integer	Example: `37`
`container_registry_size`	Integer	Example: `0`
`job_artifacts_size`	Integer	Example: `0`
`lfs_objects_size`	Integer	Example: `0`
`packages_size`	Integer	Example: `0`
`pipeline_artifacts_size`	Integer	Example: `0`
`repository_size`	Integer	Example: `1.03809e+06`
`snippets_size`	Integer	Example: `0`
`storage_size`	Integer	Example: `1.03809e+06`
`uploads_size`	Integer	Example: `0`
`wiki_size`	Integer	Example: `0`

APIEntitiesTaskCompletionStatus

Property	Type	Description
`completed_count`	Integer	Example: `3`
`count`	Integer	Example: `5`

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

APIEntitiesUserSafe

Property	Type	Description
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`username`	String	Example: `admin`

List all groups

Create a group

Retrieve a group

Update group attributes

Schedule a group for deletion

Archive a group

List all descendant groups

List all shared groups

List all invited groups

List all issues for a group

Retrieve issues statistics for a group

Retrieve pending reassignments

Reassign placeholders

Workhorse authorization for the reassignment CSV file

List all projects in a group

List all shared projects

Transfer a project to a group

Restore a group

List all runners in a group

Reset runner registration token

Add a group to a group

Remove a group from a group

Remove a shared project from a group

List all subgroups

Transfer a group

List all transfer locations for a group

Transfer a group to an organization

Unarchive a group

List all uploads for a group

Upload a file to a group

Workhorse authorize the file upload

Download an uploaded file by secret and filename

Delete an uploaded file by secret and filename

Download an uploaded file by ID

Delete an uploaded file by ID

Get the users list of a group

List all groups available to invite to a project

Reset the runner registration token for the instance

Schemas

APIEntitiesBasicProjectDetails

APIEntitiesCiResetTokenResult

APIEntitiesCiRunner

APIEntitiesContainerExpirationPolicy

APIEntitiesCustomAttribute

APIEntitiesGroup

APIEntitiesGroupDetail

APIEntitiesGroupUpload

APIEntitiesIssuableReferences

APIEntitiesIssuableTimeStats

APIEntitiesIssue

APIEntitiesLicenseBasic

APIEntitiesMarkdownUploadAdmin

APIEntitiesMilestone

APIEntitiesNamespaceBasic

APIEntitiesNamespaceRootStorageStatistics

APIEntitiesProject

APIEntitiesProjectStatistics

APIEntitiesTaskCompletionStatus

APIEntitiesUserBasic

APIEntitiesUserSafe

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error