Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ MergeRequest/ This API is used to obtain repository approvers or mergers.
Updated on 2026-05-12 GMT+08:00
View PDF
Share

This API is used to obtain repository approvers or mergers.

Function

This API is used to obtain repository approvers or mergers.

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

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/merge-requests/assignee-candidates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can call the API used to query all repositories of the user to query the project list to obtain the repository ID.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

target_branch

Yes

String

Definition

Target branch. Branch to which the code is to be merged when an MR is created.

merge_request_iid

No

Integer

Definition

MR IID.

Value range:

1~2147483647

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

search

No

String

Definition

Query keyword for fuzzy match, such as username, user alias, and tenant name.

search_by_name_list

No

String

Definition

Match users in batches. You can transfer max. 50 usernames and nicknames at once, separating them with commas (,). Example: "zhangsan, lisi, wangwu"

target_repository_id

No

String

Definition

Target repository ID. Repository to which the code is to be merged when an MR is created.

view

No

String

Definition

approver: Obtain the approver.

assignee: Obtain the merger.

Enumeration values:

  • approver

  • assignee

only_developers

No

Boolean

Definition

true: Only developers are returned.

Default value:

false

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token 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.

Constraints

N/A

Range

A string that can contain 1 to 100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Definition

Total number of repository approvers or mergers.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of MRVoteReviewerDto objects

Definition

MR review user details.
Table 6 MRVoteReviewerDto

Parameter

Type

Description

id

Integer

Definition

User ID.

Value range:

1~2147483647

name

String

Definition

Username.

username

String

Definition

Username.

state

String

Definition:

User status

Value range:

  • active: available account

  • blocked: locked user

  • error: The user is not found

Enumeration values:

  • active

  • blocked

  • error

service_license_status

Integer

Service-level permission status. 0: disabled; 1: enabled

avatar_url

String

User profile picture URL

avatar_path

String

User profile picture path

email

String

User email

name_cn

String

Username (CN)

web_url

String

User homepage

nick_name

String

User alias

tenant_name

String

Tenant name

error_message

String

Definition

When some query APIs detect that the user permission in the transfer parameter is insufficient or the user does not exist, the user is returned but the field is not empty for information.

is_committer

Boolean

Definition

Committer or not.

is_verified

Boolean

Definition

Authenticated committer or not.

has_permission

Boolean

Definition

Whether you have the related permissions.

Status code: 401

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/repositories/2112015538/merge-requests/assignee-candidates

Example Responses

Status code: 200

Response body of repository approvers or mergers.

[ {
  "id" : 23559,
  "name" : "example_name/deploy_admin_trust",
  "username" : "0e87c9d84a7f49e786f9ee4bfaaf1b0f",
  "state" : "active",
  "service_license_status" : 1,
  "avatar_path" : null,
  "email" : "0e87c9d84a7f49e786f9ee4bfaaf1b0f@example.com",
  "name_cn" : "example_name/deploy_admin_trust",
  "web_url" : "https://example.com/0e87c9d84a7f49e786f9ee4bfaaf1b0f",
  "nick_name" : null,
  "tenant_name" : "example_name",
  "error_message" : null,
  "is_committer" : false,
  "is_verified" : false,
  "has_permission" : true
} ]

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Response body of repository approvers or mergers.

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: MergeRequest