Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Obtaining the Repository Contributor List
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Repository Contributor List

Function

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

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:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/contributors

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

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

order_by

No

String

Definition:

Sorting order.

Value range:

  • name: Name.

  • email: Email.

  • commits: Number of commits.

Default value:

commits

Enumeration values:

  • name

  • email

  • commits

sort

No

String

Definition:

Return sorting.

  • asc: It is returned by submitted quantity in ascending order.

  • desc: It is returned by submitted quantity in descending order.

Default value:

asc

Enumeration values:

  • asc

  • desc

ref_name

No

String

Definition:

Branch or tag name.

Constraints:

Do not start with hyphen (-), period (.) refs, heads, refs, or remotes. Do not end with . / .lock. Spaces and the following characters are not supported: [ \ < ~ ^ : ? * ! ( ) ' " |

Value range:

1 to 200 characters.

Default value:

Default branch of the repository.

skip_merge

No

Boolean

Definition:

Whether to skip the merge.

Constraints:

N/A.

Value range:

  • false: Skip the merge.

  • true: Do not skip the merge.

Default value:

false

author

No

String

Definition:

Committer.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

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 header parameters

Parameter

Type

Description

X-Total

String

Total number of results of the current request.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of ContributorDto objects

Contributor information list.
Table 6 ContributorDto

Parameter

Type

Description

name

String

Definition:

Username.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

email

String

Definition:

Email address.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

commits

Integer

Definition:

Commits.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Value range:

1~2147483647

nick_name

String

Definition:

Alias.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

tenant_name

String

Definition:

Tenant name.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

user_name

String

Definition:

Username.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

None

Example Responses

Status code: 200

OK

[ {
  "name" : "abc",
  "email" : "aaaa@example.com",
  "commits" : 4,
  "nick_name" : null,
  "tenant_name" : "adc",
  "user_name" : "sda"
} ]

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

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Repository