Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Obtaining the Repository Group List

Updated on 2026-01-27 GMT+08:00

View PDF

Obtaining the Repository Group List

Function

This API is used to obtain the list of repository groups.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsrepo:group:getGroup	Read	-	-	-	-

URI

GET https://{hostURL}/v4/groups/list

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
search	No	String	Definition Search content. Default value: false
all_available	No	Boolean	Definition All available repository groups.
order_by	No	String	Definition: Sorting order. name: name. path: path. id: unique identifier. created_at: creation time. updated_at: update time. Default value: created_at Enumeration values: name path id created_at updated_at
sort	No	String	Definition Sorting order. asc: ascending. desc: descending Default value: desc Enumeration values: asc desc
starred	No	Boolean	Definition Favorited or not. Default value: false
offset	No	Integer	Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Definition Number of returned records. Value range: 1~100 Default value: 20
owned	No	Boolean	Definition

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range 1–100,000 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of GroupBaseDto objects	Definition: Repository group list.

**Table 4** GroupBaseDto
Parameter	Type	Description
project_id	String	Definition Project ID. Range 1–1,000 characters.
project_name	String	Definition Project name. Range 1–1,000 characters.
ancestor_ids	Array of integers	Definition Repository group ID. Value range: 1~2147483647
ancestor_names	Array of strings	Definition Repository group name.
develop_mode	String	Definition Development mode. Normal: CR. Range 1–1,000 characters.
id	Integer	Definition Record ID. Value range: 1~2147483647
name	String	Definition Name. Range 1–1,000 characters.
path	String	Definition Path. Range 1–1,000 characters.
group_level	Integer	Definition Repository group level. Value range: 1~2147483647
description	String	Definition Description. Range 1–1,000 characters.
subgroup_count	Integer	Definition Number of child repository groups. Value range: 1~2147483647
project_count	Integer	Definition Number of repositories. Value range: 1~2147483647
group_role	Integer	Definition Repository group role. Value range: 1~2147483647
group_members_count	Integer	Definition Number of members in a repository group. Value range: 1~2147483647
descendant_type	String	Definition Type. Range 1–1,000 characters.
visibility_level	Integer	Definition Visibility: 0 or 20. Value range: 1~2147483647
visibility	String	Definition Visibility: private or public. Range 1–1,000 characters.
is_project_admin	Integer	Definition Whether the user is the project creator. Value range: 1~2147483647
is_group_creator	Integer	Definition Whether the user is the creator of a repository group. Value range: 1~2147483647 Default value: 0
is_repo_creator	Integer	Definition Whether the user is the repository creator. Value range: 1~2147483647
lfs_enabled	Boolean	Definition LFS enabled or not.
full_name	String	Definition Full name. Range 1–1,000 characters.
full_path	String	Definition Full path. Range 1–1,000 characters.
item_type	String	Definition Item type. Range 1–1,000 characters.
parent_id	Integer	Definition Parent repository group ID. Value range: 1~2147483647
my_role	GroupMyRoleDtoV4 object	Definition My role.
members	Integer	Definition Member. Value range: 1~2147483647
web_url	String	Definition URL. Range 1–1,000 characters.
created_at	String	Definition Creation time. Range 1–1,000 characters.
sub_group_count	Integer	Definition Number of child repository groups. Value range: 1~2147483647
last_owner	Boolean	Definition Whether the user is the last owner.
starred	Boolean	Definition Favorited or not.

**Table 5** GroupMyRoleDtoV4
Parameter	Type	Description
id	Integer	Definition: Record ID. Value range: 1~2147483647
access_level	Integer	Definition Role. Value range: 1~2147483647
role_namecn	String	Definition: Role name in Chinese. Value range: 1 to 1,000 characters.
role_namen	String	Definition: Role name in English. Value range: 1 to 1,000 characters.
source_id	Integer	Definition: Resource ID. Value range: 1~2147483647
source_type	String	Definition: Resource type. Value range: Group project 1 to 1,000 characters.
user_id	Integer	Definition: User ID. Value range: 1~2147483647
notification_level	Integer	Definition: Notification. Value range: 1~2147483647
created_at	String	Definition: Creation time. Value range: 1 to 1,000 characters.
updated_at	String	Definition: Update time. Value range: 1 to 1,000 characters.
is_project_admin	Integer	Definition: Whether the user is the project creator. Value range: 1~2147483647
is_group_creator	Integer	Definition: Whether the user is the creator of a repository group. Value range: 1~2147483647
is_repo_creator	Integer	Definition: Whether the user is the repository creator. Value range: 1~2147483647
role_show_flag	Integer	Definition: Role display. Value range: 1~2147483647

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Example Requests

GET https://{endpoint}/v4/groups/list

Example Responses

Status code: 200

Obtain the list of repository groups.

[ {
  "project_id" : "c65b44ca43b04961860e728cb91acfc6",
  "project_name" : "Scrum_ltest_sync",
  "ancestor_ids" : [ 2111921555 ],
  "ancestor_names" : [ "te" ],
  "develop_mode" : "normal",
  "id" : 2111921555,
  "name" : "te",
  "web_url" : null,
  "lfs_enabled" : true,
  "full_name" : "te",
  "full_path" : "te",
  "path" : "te",
  "visibility" : "public",
  "description" : null,
  "item_type" : "Group",
  "parent_id" : 2111919908,
  "my_role" : {
    "id" : 1084102,
    "access_level" : 50,
    "role_namecn" : "Project administrator",
    "role_namen" : "project_admin",
    "source_id" : 2111921555,
    "source_type" : "Namespace",
    "user_id" : 7574,
    "notification_level" : 3,
    "created_at" : "2025-06-20T22:32:56.000+08:00",
    "updated_at" : "2025-06-20T22:32:56.000+08:00",
    "is_project_admin" : 1,
    "is_group_creator" : 1,
    "is_repo_creator" : 0,
    "role_show_flag" : 6
  },
  "members" : 2,
  "created_at" : "2025-06-20T22:32:56.000+08:00",
  "project_count" : 0,
  "sub_group_count" : 0,
  "last_owner" : true,
  "starred" : false
} ]

Status code: 401

Unauthorized

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

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code	Description
200	Obtain the list of repository groups.
401	Unauthorized
403	Bad Request

Error Codes

See Error Codes.

Parent topic: Group

Previous topic: Obtaining the List of Repository Groups That the Current User Has Management Permissions for in a Project

Next topic: Obtaining the List of Members That Can Be Added to a Repository Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot