Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ MergeRequest/ Obtaining the Merge Request Template List
Updated on 2026-05-12 GMT+08:00
View PDF
Share

Obtaining the Merge Request Template List

Function

This API is used to obtain the merge request template list.

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}/merge-requests/templates

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

view

Yes

String

Definition

Range returned by the result set.

Range

  • default: returns the template whose name is "default template".

  • list: returns the template list.

Default value:

default

Enumeration values:

  • default

  • list

template_name

No

String

Definition

Name of the template to be searched for.

Range

1–100,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. 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 MR templates.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of RepositoryMergeRequestTemplateDto objects

Response body of the repository merge request template
Table 6 RepositoryMergeRequestTemplateDto

Parameter

Type

Description

id

Integer

Definition

Primary key ID of an MR template.

Value range:

1~2147483647

description

String

Definition

Description.

created_at

String

Definition

Creation time.

updated_at

String

Definition

Update time.

template_name

String

Definition

Template name.

merge_request_title

String

Definition

MR title. (This parameter is valid when the MR title is not auto extracted.)

is_default

Boolean

Definition

Whether to set as the default template.

is_wip

Boolean

Definition

Whether to add [WIP] to the title.

auto_extract_mr_title

Integer

Definition

Auto extract MR title.

0: not extract

1: extract commit message

2: extract the E2E ticket title

Value range:

0~2

creator

UserBasicDto object

Definition

Creator.

repository_id

Integer

Definition:

Repository ID.

from

MergeRequestTemplateFromDto object

Definition

Template Source (In the inheritance scenario, the template may inherit settings from the upper-level code group or project; in the non-inheritance scenario, it is null).
Table 7 UserBasicDto

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.
Table 8 MergeRequestTemplateFromDto

Parameter

Type

Description

path

String

Definition

Source URL. You can click the URL to go to the merge request template settings of the project, repository group, or repository.

type

String

Definition

repository: Settings are from the repository.

group: Settings are inherited from the repository group.

project: Settings are inherited from the project.

Enumeration values:

  • repository

  • group

  • project

repository_id

Integer

Definition

Repository ID, which is null when not sourced from a repository.

group_id

Integer

Definition

Code group ID. If it does not come from a code group, it is null.

project_id

String

Definition

Project ID. If it does not come from a project, it is null.

Status code: 401

Table 9 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/123/merge-requests/templates

Example Responses

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

ok

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: MergeRequest