Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtaining Reviewer Information Based on the Repo Short ID and Merge Request Short ID
Updated on 2025-03-28 GMT+08:00

Obtaining Reviewer Information Based on the Repo Short ID and Merge Request Short ID

Function

Obtain the reviewer information based on the repository short ID and merge request short ID.

URI

GET/v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/approval-reviewers

Table 1 Query parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

String

Explanation:

Repository short ID.

Constraints:

Mandatory

Range:

0–2147483647

Default value:

None

merge_request_iid

Yes

Integer

Explanation:

Short ID of a merge request.

Constraints:

Mandatory

Range:

0–2147483647

Default value:

None

page

No

Integer

Explanation:

Number of records on each page.

Range:

Minimum value: 1

Maximum value: 100

Default value:

100

per_page

No

Integer

Explanation:

Number of records on each page.

Range:

Minimum value: 1

Maximum value: 100

Default value:

20

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory

Range:

1–100,000 characters.

Default value:

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

MergeRequestApprovalReviewersDto object

Explanation:

Reviewer information.

status

String

Explanation:

Response status of the API.

Range:

  • success: The API call is successful.
  • failed: The API call failed.
Table 4 MergeRequestApprovalReviewersDto

Parameter

Type

Description

approval_merge_request_reviewers

Array of ApprovalUserDto objects

Explanation:

Reviewer list

Table 5 ApprovalUserDto

Parameter

Type

Description

id

Integer

Explanation:

Auto-increment primary key

username

String

Explanation:

Username.

name

String

Explanation:

Name

nick_name

String

Explanation:

Alias

state

String

Explanation:

Review status

Example Requests

GET https://{endpoint}/v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/approval-reviewers

Example Responses

Status code: 200

OK
{
    "result": {
        "approval_merge_request_reviewers": [{
            "id": 453613,
            "name": "test",
            "username": "test",
            "state": "required",
            "nick_name": "test"
        }]
    },
    "status": "success"
}

Status Code

Status Code

Description

200

OK

Error code.

See Error Codes.