Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Querying the Member Group List Under an Organization
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Querying the Member Group List Under an Organization

Function

Query the member group list under an organization.

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:getMembers

Read

-

-

-

-

URI

GET https://{hostURL}/v4/groups/{group_id}/user-groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

Integer

Definition

Repository group ID, which is the numeric ID next to Group ID on the repository group homepage.

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

search

No

String

Definition:

ID of a user group in an organization

Value range:

1–1,000 characters.

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

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

[items]

Array of ProjectUserGroupDto objects

Member group list
Table 5 ProjectUserGroupDto

Parameter

Type

Description

id

Integer

Definition:

User group record ID

Value range:

1~2147483647

user_group_id

String

Definition:

User group ID

Value range:

1–1,000 characters.

name

String

Definition:

User group name

Value range:

1–1,000 characters.

project_id

String

Definition:

ID of the project where the user group is located

Value range:

1–1,000 characters.

tenant_id

String

Definition:

ID of the tenant to which the user group belongs

Value range:

1–1,000 characters.

group_type

String

Definition:

Type of the user group

Value range:

1–1,000 characters.

member_count

Integer

Definition:

Number of user group members

Value range:

0~2147483647

created_at

String

Definition:

Creation time

Value range:

1–1,000 characters.

updated_at

String

Definition:

Update time

Value range:

1–1,000 characters.

description

String

Definition:

Description

Value range:

1–1,000 characters.

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.

Status code: 404

Table 8 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/{group_id}/user-groups?project_id={project_id}&offset=0&limit=20

Example Responses

Status code: 200

Query the member group list under an organization.

[ {
  "id" : 345,
  "user_group_id" : "2e191c60e5c04aa9a57a27344d4b74d4",
  "name" : "team1",
  "project_id" : null,
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "group_type" : null,
  "member_count" : 1,
  "created_at" : "2025-09-17T19:30:03.275+08:00",
  "updated_at" : "2025-09-17T19:30:03.275+08:00",
  "description" : null
}, {
  "id" : 346,
  "user_group_id" : "2e191c60e5c04aa9a57a27344d4b74d4",
  "name" : "team2",
  "project_id" : null,
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "group_type" : null,
  "member_count" : 1,
  "created_at" : "2025-09-17T19:30:03.275+08:00",
  "updated_at" : "2025-09-17T19:30:03.275+08:00",
  "description" : null
} ]

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 code: 404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Project Not Found. Project Not Found"
}

Status Codes

Status Code

Description

200

Query the member group list under an organization.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Group