Gitlab
  1. groups
Gitlab
  • GitLab API v4
    • Topics
      • Introduction
      • Authentication
    • Endpoints
      • access_requests
        • List access requests for a project
        • Requests access for the authenticated user to a project
        • Approves access for the authenticated user to a project
        • Denies a project access request for the given user
        • Denies a project access request for the given user
        • List access requests for a group
        • Requests access for the authenticated user to a group
        • Approves access for the authenticated user to a group
        • Denies a group access request for the given user
      • access_tokens
        • List access tokens for a project
        • Creates an access token for a project
        • Revokes an access token
      • Retrieve metadata information for this GitLab instance
      • Retrieve metadata information for this GitLab instance
  • application
    • Get the current application settings
      GET
    • Modify application settings
      PUT
  • ci
    • Validation of .gitlab-ci.yml content
      POST
  • deploy_keys
    • /v3/deploy_keys
      GET
  • dockerfiles
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
  • gitignores
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
  • gitlab_ci_ymls
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
  • groups
    • Get a groups list
      GET
    • Create a group. Available only for users who can create groups.
      POST
    • Get list of owned groups for authenticated user
      GET
    • Remove a group.
      DELETE
    • Get a single group, with containing projects.
      GET
    • Update a group. Available only for users who can administrate groups.
      PUT
    • Gets a list of access requests for a group.
      GET
    • Requests access for the authenticated user to a group.
      POST
    • Denies an access request for the given user.
      DELETE
    • Approves an access request for the given user.
      PUT
    • Get a list of group issues
      GET
    • Gets a list of group or project members viewable by the authenticated user.
      GET
    • Adds a member to a group or project.
      POST
    • Removes a user from a group or project.
      DELETE
    • Gets a member of a group or project.
      GET
    • Updates a member of a group or project.
      PUT
    • Get group level notification level settings, defaults to Global
      GET
    • Update group level notification level settings, defaults to Global
      PUT
    • Get a list of projects in this group.
      GET
    • Transfer a project to the group namespace. Available only for admin.
      POST
  • hooks
    • Get the list of system hooks
    • Create a new system hook
    • Delete a hook
    • Test a hook
  • internal
    • /v3/internal/allowed
    • /v3/internal/broadcast_message
    • /v3/internal/check
    • /v3/internal/discover
    • /v3/internal/lfs_authenticate
    • /v3/internal/merge_request_urls
    • /v3/internal/two_factor_recovery_codes
  • issues
    • Get currently authenticated user's issues
  • keys
    • Get single ssh key by id. Only available to admin users
  • licenses
    • Get the list of the available license template
    • Get the text for a specific license
  • namespaces
    • Get a namespaces list
  • notification_settings
    • Get global notification level settings and email, defaults to Participate
    • Update global notification level settings and email, defaults to Participate
  • projects
    • Get a projects list for authenticated user
    • Create new project
    • Get all projects for admin user
    • Fork new project for the current user or provided namespace.
    • Get an owned projects list for authenticated user
    • Search for projects the current user has access to
    • Gets starred project for the authenticated user
    • Create new project for a specified user. Only available to admin users.
    • Get a list of visible projects for authenticated user
    • Remove a project
    • Get a single project
    • Update an existing project
    • Trigger a GitLab project build
    • Gets a list of access requests for a project.
    • Requests access for the authenticated user to a project.
    • Denies an access request for the given user.
    • Approves an access request for the given user.
    • Archive a project
    • Get all project boards
    • Get the lists of a project board
    • Create a new board list
    • Delete a board list
    • Get a list of a project board
    • Moves a board list to a new position
    • Get a project builds
    • Download the artifacts file from build
    • Get a specific build of a project
    • Download the artifacts file from build
    • Keep the artifacts to prevent them from being deleted
    • Cancel a specific build of a project
    • Erase build (remove artifacts and build trace)
    • Trigger a manual build
    • Retry a specific build of a project
    • Get a trace of a specific build of a project
    • Get a specific project's deploy keys
    • Add new deploy key to currently authenticated user
    • Delete deploy key for a project
    • Get single deploy key
    • Disable a deploy key for a project
    • Enable a deploy key for a project
    • Get all deployments of the project
    • Gets a specific deployment
    • Get all environments of the project
    • Creates a new environment
    • Deletes an existing environment
    • Updates an existing environment
    • Get events for a single project
    • Remove a forked_from relationship
    • Mark this project as forked from another
    • Get project hooks
    • Add hook to project
    • Deletes project hook
    • Get a project hook
    • Update an existing project hook
    • Get a list of project issues
    • Create a new project issue
    • Delete a project issue
    • Get a single project issue
    • Update an existing issue
    • Add spent time for a project issue
    • Get a list of project +awardable+ award emoji
    • Award a new Emoji
    • Delete a +awardables+ award emoji
    • Get a specific award emoji
    • Move an existing issue
    • Get a list of project +awardable+ award emoji
    • Award a new Emoji
    • Delete a +awardables+ award emoji
    • Get a specific award emoji
    • Reset spent time for a project issue
    • Reset the time estimate for a project issue
    • Set a time estimate for a project issue
    • Show time stats for a project issue
    • Create a todo on an issuable
    • Get a list of project +noteable+ notes
    • Create a new +noteable+ note
    • Delete a +noteable+ note
    • Get a single +noteable+ note
    • Update an existing +noteable+ note
    • Unsubscribe from a resource
    • Subscribe to a resource
    • Get a specific project's deploy keys
    • Add new deploy key to currently authenticated user
    • Delete deploy key for a project
    • Get single deploy key
    • Disable a deploy key for a project
    • Enable a deploy key for a project
    • Delete an existing label
    • Get all labels of the project
    • Create a new label
    • Update an existing label. At least one optional parameter is required.
    • Unsubscribe from a resource
    • Subscribe to a resource
    • Gets a list of group or project members viewable by the authenticated user.
    • Adds a member to a group or project.
    • Removes a user from a group or project.
    • Gets a member of a group or project.
    • Updates a member of a group or project.
    • Get a single merge request
    • Update a merge request
    • Cancel merge if "Merge When Pipeline Succeeds" is enabled
    • Show the merge request changes
    • List issues that will be closed on merge
    • Get the comments of a merge request
    • Post a comment to a merge request
    • Get the commits of a merge request
    • Merge a merge request
    • Unsubscribe from a resource
    • Subscribe to a resource
    • List merge requests
    • Create a merge request
    • Delete a merge request
    • Get a single merge request
    • Update a merge request
    • Add spent time for a project merge_request
    • Get a list of project +awardable+ award emoji
    • Award a new Emoji
    • Delete a +awardables+ award emoji
    • Get a specific award emoji
    • Cancel merge if "Merge When Pipeline Succeeds" is enabled
    • Show the merge request changes
    • List issues that will be closed on merge
    • Get the comments of a merge request
    • Post a comment to a merge request
    • Get the commits of a merge request
    • Merge a merge request
    • Get a list of project +awardable+ award emoji
    • Award a new Emoji
    • Delete a +awardables+ award emoji
    • Get a specific award emoji
    • Reset spent time for a project merge_request
    • Reset the time estimate for a project merge_request
    • Set a time estimate for a project merge_request
    • Show time stats for a project merge_request
    • Create a todo on an issuable
    • Get a list of merge request diff versions
    • Get a single merge request diff version
    • Get a list of project +noteable+ notes
    • Create a new +noteable+ note
    • Delete a +noteable+ note
    • Get a single +noteable+ note
    • Update an existing +noteable+ note
    • Unsubscribe from a resource
    • Subscribe to a resource
    • Get a list of project milestones
    • Create a new project milestone
    • Get a single project milestone
    • Update an existing project milestone
    • Get all issues for a single project milestone
    • Get project level notification level settings, defaults to Global
    • Update project level notification level settings, defaults to Global
    • Create a new pipeline
    • Get all Pipelines of the project
    • Gets a specific pipeline for the project
    • Cancel all builds in the pipeline
    • Retry failed builds in the pipeline
    • Get an archive of the repository
    • Get a raw file contents
    • Get a project repository branches
    • Create branch
    • Delete a branch
    • Get a single branch
    • Protect a single branch
    • Unprotect a single branch
    • Get a project repository commits
    • Commit multiple file changes as one commit
    • Get a specific commit of a project
    • Get a raw file contents
    • Get builds for a specific commit of a project
    • Cherry pick commit into a branch
    • Get a commit's comments
    • Post comment to commit
    • Get the diff for a specific commit of a project
    • Get a commit's statuses
    • Compare two branches, tags, or commits
    • Get repository contributors
    • Delete an existing file in repository
    • Get a file from repository
    • Create new file in repository
    • Update existing file in repository
    • /v3/projects/{id}/repository/merged_branches
    • Get a raw blob contents by blob sha
    • Get a project repository tags
    • Create a new repository tag
    • Delete a repository tag
    • Get a single repository tag
    • Add a release note to a tag
    • Update a tag's release note
    • Get a project repository tree
    • Get runners available for project
    • Enable a runner for a project
    • Disable project's runner
    • Set asana service for project
    • Set assembla service for project
    • Set bamboo service for project
    • Set bugzilla service for project
    • Set buildkite service for project
    • Set builds-email service for project
    • Set campfire service for project
    • Set custom-issue-tracker service for project
    • Set drone-ci service for project
    • Set emails-on-push service for project
    • Set external-wiki service for project
    • Set flowdock service for project
    • Set gemnasium service for project
    • Set hipchat service for project
    • Set irker service for project
    • Set jira service for project
    • Set kubernetes service for project
    • Set mattermost service for project
    • Set mattermost-slash-commands service for project
    • Trigger a slash command for mattermost-slash-commands
    • Set pipelines-email service for project
    • Set pivotaltracker service for project
    • Set pushover service for project
    • Set redmine service for project
    • Set slack service for project
    • Set slack-slash-commands service for project
    • Trigger a slash command for slack-slash-commands
    • Set teamcity service for project
    • Delete a service for project
    • Get the service settings for project
    • Share the project with a group
    • /v3/projects/{id}/share/{group_id}
    • Get all project snippets
    • Create a new project snippet
    • Get a list of project +noteable+ notes
    • Create a new +noteable+ note
    • Delete a +noteable+ note
    • Get a single +noteable+ note
    • Update an existing +noteable+ note
    • Delete a project snippet
    • Get a single project snippet
    • Update an existing project snippet
    • Get a list of project +awardable+ award emoji
    • Award a new Emoji
    • Delete a +awardables+ award emoji
    • Get a specific award emoji
    • Get a list of project +awardable+ award emoji
    • Award a new Emoji
    • Delete a +awardables+ award emoji
    • Get a specific award emoji
    • Get a raw project snippet
    • Unstar a project
    • Star a project
    • Post status to a commit
    • Get triggers list
    • Create a trigger
    • Delete a trigger
    • Get specific trigger of a project
    • Unarchive a project
    • Upload a file
    • Get the users list of a project
    • Get project variables
    • Create a new variable in a project
    • Delete an existing variable from a project
    • Get a specific variable from a project
    • Update an existing variable from a project
  • runners
    • Get runners available for user
    • Get all runners - shared and specific
    • Remove a runner
    • Get runner's details
    • Update runner's details
  • session
    • Login to get token
  • sidekiq
    • Get the Sidekiq Compound metrics. Includes queue, process, and job statistics
    • Get the Sidekiq job statistics
    • Get the Sidekiq process metrics
    • Get the Sidekiq queue metrics
  • snippets
    • Get a snippets list for authenticated user
    • Create new snippet
    • List all public snippets current_user has access to
    • Remove snippet
    • Get a single snippet
    • Update an existing snippet
    • Get a raw snippet
  • templates
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
    • Get the list of the available template
    • Get the text for a specific template present in local filesystem
    • Get the list of the available license template
    • Get the text for a specific license
  • todos
    • Mark all todos as done
    • Get a todo list
    • Mark a todo as done
  • user
    • Get the currently authenticated user
    • Get the currently authenticated user's email addresses
    • Add new email address to the currently authenticated user
    • Delete an email address from the currently authenticated user
    • Get a single email address owned by the currently authenticated user
    • Get the currently authenticated user's SSH keys
    • Add a new SSH key to the currently authenticated user
    • Delete an SSH key from the currently authenticated user
    • Get a single key owned by currently authenticated user
  • users
    • Get the list of users
    • Create a user. Available only for admins.
    • Delete a user. Available only for admins.
    • Get a single user
    • Update a user. Available only for admins.
    • Block a user. Available only for admins.
    • Get the emails addresses of a specified user. Available only for admins.
    • Add an email address to a specified user. Available only for admins.
    • Delete an email address of a specified user. Available only for admins.
    • Get the contribution events of a specified user
    • Get the SSH keys of a specified user. Available only for admins.
    • Add an SSH key to a specified user. Available only for admins.
    • Delete an existing SSH key from a specified user. Available only for admins.
    • Unblock a user. Available only for admins.
  • version
    • Get the version information of the GitLab instance.
  1. groups

Get a single group, with containing projects.

GET
/v3/groups/{id}
groups
Get a single group, with containing projects.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://gitlab.com/api/v3/groups/'
Response Response Example
{
  "avatar_url": "string",
  "description": "string",
  "id": "string",
  "lfs_enabled": "string",
  "name": "string",
  "path": "string",
  "projects": {
    "archived": "string",
    "avatar_url": "string",
    "builds_enabled": "string",
    "container_registry_enabled": "string",
    "created_at": "string",
    "creator_id": "string",
    "default_branch": "string",
    "description": "string",
    "forked_from_project": {
      "http_url_to_repo": "string",
      "id": "string",
      "name": "string",
      "name_with_namespace": "string",
      "path": "string",
      "path_with_namespace": "string",
      "web_url": "string"
    },
    "forks_count": "string",
    "http_url_to_repo": "string",
    "id": "string",
    "issues_enabled": "string",
    "last_activity_at": "string",
    "lfs_enabled": "string",
    "merge_requests_enabled": "string",
    "name": "string",
    "name_with_namespace": "string",
    "namespace": {
      "id": "string",
      "kind": "string",
      "name": "string",
      "path": "string"
    },
    "only_allow_merge_if_all_discussions_are_resolved": "string",
    "only_allow_merge_if_build_succeeds": "string",
    "open_issues_count": "string",
    "owner": {
      "avatar_url": "string",
      "id": "string",
      "name": "string",
      "state": "string",
      "username": "string",
      "web_url": "string"
    },
    "path": "string",
    "path_with_namespace": "string",
    "public": "string",
    "public_builds": "string",
    "request_access_enabled": "string",
    "runners_token": "string",
    "shared_runners_enabled": "string",
    "shared_with_groups": "string",
    "snippets_enabled": "string",
    "ssh_url_to_repo": "string",
    "star_count": "string",
    "statistics": {
      "build_artifacts_size": "string",
      "commit_count": "string",
      "lfs_objects_size": "string",
      "repository_size": "string",
      "storage_size": "string"
    },
    "tag_list": "string",
    "visibility_level": "string",
    "web_url": "string",
    "wiki_enabled": "string"
  },
  "request_access_enabled": "string",
  "shared_projects": {
    "archived": "string",
    "avatar_url": "string",
    "builds_enabled": "string",
    "container_registry_enabled": "string",
    "created_at": "string",
    "creator_id": "string",
    "default_branch": "string",
    "description": "string",
    "forked_from_project": {
      "http_url_to_repo": "string",
      "id": "string",
      "name": "string",
      "name_with_namespace": "string",
      "path": "string",
      "path_with_namespace": "string",
      "web_url": "string"
    },
    "forks_count": "string",
    "http_url_to_repo": "string",
    "id": "string",
    "issues_enabled": "string",
    "last_activity_at": "string",
    "lfs_enabled": "string",
    "merge_requests_enabled": "string",
    "name": "string",
    "name_with_namespace": "string",
    "namespace": {
      "id": "string",
      "kind": "string",
      "name": "string",
      "path": "string"
    },
    "only_allow_merge_if_all_discussions_are_resolved": "string",
    "only_allow_merge_if_build_succeeds": "string",
    "open_issues_count": "string",
    "owner": {
      "avatar_url": "string",
      "id": "string",
      "name": "string",
      "state": "string",
      "username": "string",
      "web_url": "string"
    },
    "path": "string",
    "path_with_namespace": "string",
    "public": "string",
    "public_builds": "string",
    "request_access_enabled": "string",
    "runners_token": "string",
    "shared_runners_enabled": "string",
    "shared_with_groups": "string",
    "snippets_enabled": "string",
    "ssh_url_to_repo": "string",
    "star_count": "string",
    "statistics": {
      "build_artifacts_size": "string",
      "commit_count": "string",
      "lfs_objects_size": "string",
      "repository_size": "string",
      "storage_size": "string"
    },
    "tag_list": "string",
    "visibility_level": "string",
    "web_url": "string",
    "wiki_enabled": "string"
  },
  "statistics": "string",
  "visibility_level": "string",
  "web_url": "string"
}

Request

Path Params
id
string 
required
The ID of a group

Responses

🟢200Get a single group, with containing projects.
application/json
Body
Transfer a project to the group namespace. Available only for admin.
avatar_url
string 
optional
description
string 
optional
id
string 
optional
lfs_enabled
string 
optional
name
string 
optional
path
string 
optional
projects
object (Project) 
optional
Unstar a project
archived
string 
optional
avatar_url
string 
optional
builds_enabled
string 
optional
container_registry_enabled
string 
optional
created_at
string 
optional
creator_id
string 
optional
default_branch
string 
optional
description
string 
optional
forked_from_project
object (BasicProjectDetails) 
optional
Get all projects for admin user
forks_count
string 
optional
http_url_to_repo
string 
optional
id
string 
optional
issues_enabled
string 
optional
last_activity_at
string 
optional
lfs_enabled
string 
optional
merge_requests_enabled
string 
optional
name
string 
optional
name_with_namespace
string 
optional
namespace
object (Namespace) 
optional
Get a namespaces list
only_allow_merge_if_all_discussions_are_resolved
string 
optional
only_allow_merge_if_build_succeeds
string 
optional
open_issues_count
string 
optional
owner
object (UserBasic) 
optional
Get a single user
path
string 
optional
path_with_namespace
string 
optional
public
string 
optional
public_builds
string 
optional
request_access_enabled
string 
optional
runners_token
string 
optional
shared_runners_enabled
string 
optional
shared_with_groups
string 
optional
snippets_enabled
string 
optional
ssh_url_to_repo
string 
optional
star_count
string 
optional
statistics
object (ProjectStatistics) 
optional
tag_list
string 
optional
visibility_level
string 
optional
web_url
string 
optional
wiki_enabled
string 
optional
request_access_enabled
string 
optional
shared_projects
object (Project) 
optional
Unstar a project
statistics
string 
optional
visibility_level
string 
optional
web_url
string 
optional
Modified at 2023-08-15 04:14:32
Previous
Remove a group.
Next
Update a group. Available only for users who can administrate groups.
Built with