Help Center/ CodeArts Repo/ API Reference/ APIs/ Group/ Obtaining Repository Group Information
Updated on 2025-03-28 GMT+08:00
View PDF
Share

Obtaining Repository Group Information

Function

Obtain repository group information.

URI

GET /v4/{project_id}/groups/{group_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

group_id

Yes

Integer

Repository group ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

creator_id

Integer

Creator ID.

project_id

String

Project ID.

created_at

String

Creation time.

description

String

Description

full_name

String

Repository group full name.

ancestor_ids

Array Integer

Repository group path ID.

ancestor_names

Array String

Repository group path name.

id

Integer

Repository group ID.

members_count

Integer

Number of repository group members.

name

String

Repository group name.

repository_count

Integer

Number of repositories.

star_count

Integer

Followed count.

starred

Boolean

Followed or not.

subgroup_count

Integer

Number of sub-groups.

visibility

String

Repository visibility. The value can be private or public.

sum

GroupSumDto

Number of MRs in the open state.
Table 4 GroupSumDto parameter in the response body

Parameter

Type

Description

open_merge_requests_count

integer

Number of MRs in the open state.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Response status code.

error_msg

String

Response error information.

Example Requests

GET https://{endpoint}/v4/{project_id}/groups/{group_id}

Example Responses

Status code: 200

OK 
{
       creator_id: 9125
       project_id: 1a92b5c48d914f11893ca983d01a1d33
       description: ''
       full_name: 1a92b5c48d914f11893ca983d01a1d33 / q / 1 / 2
       ancestor_ids:
          - 2111665683
          - 2111665684
          - 2111665685
       ancestor_names:
          - q
          - '1'
          - '2'
       id: 2111665685
       members_count: 2
       name: '2'
       repository_count: 1
       star_count: 0
       starred: false
       subgroup_count: 0
       visibility: private
       sum:
         open_merge_requests_count: 0
}

Status code: 401

Unauthorized 
{
   "error_code": "DEV.00000003"
   "error_msg": "Authentication information expired"
}

Status Code

Status Code

Description

200

OK

401

Unauthorized

Error code.

See Error Codes.

Parent topic: Group