Get Pull Request Settings

GET 
/api/v5/repos/:owner/:repo/pull_request_settings

Request

Path Parameters

owner stringrequired

Repository space address (address path of the enterprise, organization, or individual)

repo stringrequired

Repository path (path)

Query Parameters

access_token stringrequired

User authorization code

Responses

200

Successful Response

Response Headers

application/json

Schema

Schema

merge_request_setting objectrequired
idintegerrequired
project_idintegerrequired
disable_merge_by_selfbooleanrequired
created_atstringrequired
updated_atstringrequired
can_force_mergebooleanrequired
disable_squash_mergebooleanrequired
approval_required_reviewersintegerrequired
approval_required_approversintegerrequired
add_notes_after_mergedbooleanrequired
merged_commit_authorstringrequired
mark_auto_merged_mr_as_closedbooleanrequired
delete_source_branch_when_mergedbooleanrequired
auto_squash_mergebooleanrequired
squash_merge_with_no_merge_commitbooleanrequired
close_issue_when_mr_mergedbooleanrequired
can_reopenbooleanrequired
is_check_clabooleanrequired
approval_approvers object[]required
Array [
idinteger
namestring
usernamestring
iam_idstring
statestring
avatar_urlstring
name_cnstring
web_urlstring
nick_namestring
]
approval_testers object[]required
Array [
idinteger
namestring
usernamestring
iam_idstring
statestring
avatar_urlstring
name_cnstring
web_urlstring
nick_namestring
]
approval_required_testersintegerrequired
is_allow_lite_merge_requestbooleanrequired
codeowner_merge_countCode owner approval count mode, true: use merge count, code owner counts as approver; false: use individual count, code owner does not count as approver (boolean)required
forbidden_pr_related_issue_closedstringrequired
Is the "Close associated Issues after merge" option disabled?
only_allow_merge_if_all_discussions_are_resolvedbooleanrequired
only_allow_merge_if_pipeline_succeedsbooleanrequired
merge_methodstringrequired

Example (auto)

{
  "merge_request_setting": {
    "id": 0,
    "project_id": 0,
    "disable_merge_by_self": true,
    "created_at": "string",
    "updated_at": "string",
    "can_force_merge": true,
    "disable_squash_merge": true,
    "approval_required_reviewers": 0,
    "approval_required_approvers": 0,
    "add_notes_after_merged": true,
    "merged_commit_author": "string",
    "mark_auto_merged_mr_as_closed": true,
    "delete_source_branch_when_merged": true,
    "auto_squash_merge": true,
    "squash_merge_with_no_merge_commit": true,
    "close_issue_when_mr_merged": true,
    "can_reopen": true,
    "is_check_cla": true,
    "approval_approvers": [
      {
        "id": 0,
        "name": "string",
        "username": "string",
        "iam_id": "string",
        "state": "string",
        "avatar_url": "string",
        "name_cn": "string",
        "web_url": "string",
        "nick_name": "string"
      }
    ],
    "approval_testers": [
      {
        "id": 0,
        "name": "string",
        "username": "string",
        "iam_id": "string",
        "state": "string",
        "avatar_url": "string",
        "name_cn": "string",
        "web_url": "string",
        "nick_name": "string"
      }
    ],
    "approval_required_testers": 0,
    "is_allow_lite_merge_request": true,
    "codeowner_merge_count": true,
    "forbidden_pr_related_issue_closed": "string"
  },
  "only_allow_merge_if_all_discussions_are_resolved": true,
  "only_allow_merge_if_pipeline_succeeds": true,
  "merge_method": "string"
}

Example

{
  "merge_request_setting": {
    "id": 1431,
    "project_id": 2745002,
    "disable_merge_by_self": false,
    "created_at": "2024-03-28T10:04:13.523+08:00",
    "updated_at": "2024-11-13T21:30:45.261+08:00",
    "can_force_merge": false,
    "disable_squash_merge": true,
    "approval_required_reviewers": 0,
    "approval_required_approvers": 0,
    "add_notes_after_merged": false,
    "merged_commit_author": "merged_by",
    "mark_auto_merged_mr_as_closed": false,
    "delete_source_branch_when_merged": false,
    "auto_squash_merge": false,
    "squash_merge_with_no_merge_commit": false,
    "close_issue_when_mr_merged": false,
    "can_reopen": true,
    "is_check_cla": false,
    "approval_approvers": [],
    "approval_testers": [],
    "approval_required_testers": 0,
    "is_allow_lite_merge_request": false
  },
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "only_allow_merge_if_pipeline_succeeds": false,
  "merge_method": "merge"
}