Merge requests

Use this API to manage merge requests in a project, and to list the merge requests across a group or an entire instance. You can:

Automate any part of the code review process.
Connect code changes to external tools.
Send merge request information to non-GitLab systems in your preferred format.
Update, approve, merge, or block merge requests based on data from external systems.
Add commits from previous merge requests to a merge request for more context.

All API calls to non-public information require authentication.

List all group merge requests

GET /api/v4/groups/{id}/merge_requests

Lists all merge requests for a specified group and any subgroups.

Parameters

Name	Type	Description
`id` Path, required	String	The ID or URL-encoded path of the group owned by the authenticated user
`author_id` Query	Integer	Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `author_username`
`author_username` Query	String	Returns merge requests created by the given `username`. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Returns merge requests created by the given `username`. Mutually exclusive with `assignee_id`
`reviewer_username` Query	String	Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `reviewer_id`
`labels` Query	Array of strings	Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`milestone` Query	String	Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`my_reaction_emoji` Query	String	Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`reviewer_id` Query	Integer or string	Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`
`state` Query	String	Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged` Allowed values: `opened`, `closed`, `locked`, `merged`, `all` Default: `all`
`order_by` Query	String	Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8 Allowed values: `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at`, `merged_at` Default: `created_at`
`sort` Query	String	Returns merge requests sorted in `asc` or `desc` order Allowed values: `asc`, `desc` Default: `desc`
`with_labels_details` Query	Boolean	If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color` Default: `false`
`with_merge_status_recheck` Query	Boolean	If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0 Default: `false`
`created_after` Query	String (date-time)	Returns merge requests created on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`created_before` Query	String (date-time)	Returns merge requests created on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_after` Query	String (date-time)	Returns merge requests updated on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_before` Query	String (date-time)	Returns merge requests updated on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_after` Query	String (date-time)	Returns merge requests merged on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_before` Query	String (date-time)	Returns merge requests merged on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`view` Query	String	If simple, returns the `iid`, URL, title, description, and basic state of merge request Allowed values: `simple`
`scope` Query	String	Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `reviews_for_me`, `all`
`source_branch` Query	String	Returns merge requests with the given source branch
`source_project_id` Query	Integer	Returns merge requests with the given source project id
`target_branch` Query	String	Returns merge requests with the given target branch
`search` Query	String	Search merge requests against their `title` and `description`
`in` Query	String	Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma Example: `title,description`
`wip` Query	String	Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests. Mutually exclusive with `draft` Allowed values: `yes`, `no`
`draft` Query	Boolean	Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests. Mutually exclusive with `wip`
`not` Query	Object	Returns merge requests that do not match the parameters supplied
`not[author_id]` Query	Integer	`<Negated>` Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer or string	`<Negated>` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[assignee_id]`
`not[reviewer_username]` Query	String	`<Negated>` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `not[reviewer_id]`
`not[labels]` Query	Array of strings	`<Negated>` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`not[milestone]` Query	String	`<Negated>` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`not[my_reaction_emoji]` Query	String	`<Negated>` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`not[reviewer_id]` Query	Integer	`<Negated>` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `not[reviewer_username]`
`deployed_before` Query	String (date-time)	Returns merge requests deployed before the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`deployed_after` Query	String (date-time)	Returns merge requests deployed after the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`environment` Query	String	Returns merge requests deployed to the given environment Example: `production`
`merge_user_id` Query	Integer	Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`
`merge_user_username` Query	String	Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`non_archived` Query	Boolean	Returns merge requests from non archived projects only Default: `true`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

List all merge requests

GET /api/v4/merge_requests

Lists all merge requests accessible to the authenticated user. By default, returns only merge requests created by the current user. Use scope=all to get all merge requests.

Parameters

Name	Type	Description
`author_id` Query	Integer	Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `author_username`
`author_username` Query	String	Returns merge requests created by the given `username`. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Returns merge requests created by the given `username`. Mutually exclusive with `assignee_id`
`reviewer_username` Query	String	Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `reviewer_id`
`labels` Query	Array of strings	Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`milestone` Query	String	Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`my_reaction_emoji` Query	String	Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`reviewer_id` Query	Integer or string	Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`
`state` Query	String	Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged` Allowed values: `opened`, `closed`, `locked`, `merged`, `all` Default: `all`
`order_by` Query	String	Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8 Allowed values: `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at`, `merged_at` Default: `created_at`
`sort` Query	String	Returns merge requests sorted in `asc` or `desc` order Allowed values: `asc`, `desc` Default: `desc`
`with_labels_details` Query	Boolean	If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color` Default: `false`
`with_merge_status_recheck` Query	Boolean	If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0 Default: `false`
`created_after` Query	String (date-time)	Returns merge requests created on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`created_before` Query	String (date-time)	Returns merge requests created on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_after` Query	String (date-time)	Returns merge requests updated on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_before` Query	String (date-time)	Returns merge requests updated on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_after` Query	String (date-time)	Returns merge requests merged on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_before` Query	String (date-time)	Returns merge requests merged on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`view` Query	String	If simple, returns the `iid`, URL, title, description, and basic state of merge request Allowed values: `simple`
`scope` Query	String	Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `reviews_for_me`, `all` Default: `created_by_me`
`source_branch` Query	String	Returns merge requests with the given source branch
`source_project_id` Query	Integer	Returns merge requests with the given source project id
`target_branch` Query	String	Returns merge requests with the given target branch
`search` Query	String	Search merge requests against their `title` and `description`
`in` Query	String	Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma Example: `title,description`
`wip` Query	String	Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests. Mutually exclusive with `draft` Allowed values: `yes`, `no`
`draft` Query	Boolean	Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests. Mutually exclusive with `wip`
`not` Query	Object	Returns merge requests that do not match the parameters supplied
`not[author_id]` Query	Integer	`<Negated>` Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer or string	`<Negated>` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[assignee_id]`
`not[reviewer_username]` Query	String	`<Negated>` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `not[reviewer_id]`
`not[labels]` Query	Array of strings	`<Negated>` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`not[milestone]` Query	String	`<Negated>` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`not[my_reaction_emoji]` Query	String	`<Negated>` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`not[reviewer_id]` Query	Integer	`<Negated>` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `not[reviewer_username]`
`deployed_before` Query	String (date-time)	Returns merge requests deployed before the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`deployed_after` Query	String (date-time)	Returns merge requests deployed after the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`environment` Query	String	Returns merge requests deployed to the given environment Example: `production`
`merge_user_id` Query	Integer	Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`
`merge_user_username` Query	String	Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`non_archived` Query	Boolean	Returns merge requests from non archived projects only Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`422`	Unprocessable entity	—

List all project merge requests

GET /api/v4/projects/{id}/merge_requests

Lists all project merge requests.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`author_id` Query	Integer	Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `author_username`
`author_username` Query	String	Returns merge requests created by the given `username`. Mutually exclusive with `author_id`
`assignee_id` Query	Integer or string	Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `assignee_username`
`assignee_username` Query	Array of strings	Returns merge requests created by the given `username`. Mutually exclusive with `assignee_id`
`reviewer_username` Query	String	Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `reviewer_id`
`labels` Query	Array of strings	Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`milestone` Query	String	Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`my_reaction_emoji` Query	String	Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`reviewer_id` Query	Integer or string	Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`
`state` Query	String	Returns `all` merge requests or just those that are `opened`, `closed`, `locked`, or `merged` Allowed values: `opened`, `closed`, `locked`, `merged`, `all` Default: `all`
`order_by` Query	String	Returns merge requests ordered by `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at` or `merged_at` fields. Introduced in GitLab 14.8 Allowed values: `created_at`, `label_priority`, `milestone_due`, `popularity`, `priority`, `title`, `updated_at`, `merged_at` Default: `created_at`
`sort` Query	String	Returns merge requests sorted in `asc` or `desc` order Allowed values: `asc`, `desc` Default: `desc`
`with_labels_details` Query	Boolean	If `true`, response returns more details for each label in labels field: `:name`,`:color`, `:description`, `:description_html`, `:text_color` Default: `false`
`with_merge_status_recheck` Query	Boolean	If `true`, this projection requests (but does not guarantee) that the `merge_status` field be recalculated asynchronously. Introduced in GitLab 13.0 Default: `false`
`created_after` Query	String (date-time)	Returns merge requests created on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`created_before` Query	String (date-time)	Returns merge requests created on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_after` Query	String (date-time)	Returns merge requests updated on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`updated_before` Query	String (date-time)	Returns merge requests updated on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_after` Query	String (date-time)	Returns merge requests merged on or after the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`merged_before` Query	String (date-time)	Returns merge requests merged on or before the given time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`view` Query	String	If simple, returns the `iid`, URL, title, description, and basic state of merge request Allowed values: `simple`
`scope` Query	String	Returns merge requests for the given scope: `created_by_me`, `assigned_to_me`, `reviews_for_me` or `all` Allowed values: `created-by-me`, `assigned-to-me`, `created_by_me`, `assigned_to_me`, `reviews_for_me`, `all`
`source_branch` Query	String	Returns merge requests with the given source branch
`source_project_id` Query	Integer	Returns merge requests with the given source project id
`target_branch` Query	String	Returns merge requests with the given target branch
`search` Query	String	Search merge requests against their `title` and `description`
`in` Query	String	Modify the scope of the search attribute. `title`, `description`, or a string joining them with comma Example: `title,description`
`wip` Query	String	Deprecated. Use `draft` instead. Filter merge requests against their `wip` status. `yes` to return only draft merge requests, `no` to return non-draft merge requests. Mutually exclusive with `draft` Allowed values: `yes`, `no`
`draft` Query	Boolean	Filter merge requests against their `draft` status. `true` to return only draft merge requests, `false` to return non-draft merge requests. Mutually exclusive with `wip`
`not` Query	Object	Returns merge requests that do not match the parameters supplied
`not[author_id]` Query	Integer	`<Negated>` Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned_to_me`. Mutually exclusive with `not[author_username]`
`not[author_username]` Query	String	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[author_id]`
`not[assignee_id]` Query	Integer or string	`<Negated>` Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. Mutually exclusive with `not[assignee_username]`
`not[assignee_username]` Query	Array of strings	`<Negated>` Returns merge requests created by the given `username`. Mutually exclusive with `not[assignee_id]`
`not[reviewer_username]` Query	String	`<Negated>` Returns merge requests which have the user as a reviewer with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Introduced in GitLab 13.8. Mutually exclusive with `not[reviewer_id]`
`not[labels]` Query	Array of strings	`<Negated>` Returns merge requests matching a comma-separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. Predefined names are case-insensitive
`not[milestone]` Query	String	`<Negated>` Returns merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone
`not[my_reaction_emoji]` Query	String	`<Negated>` Returns merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction
`not[reviewer_id]` Query	Integer	`<Negated>` Returns merge requests which have the user as a reviewer with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `not[reviewer_username]`
`deployed_before` Query	String (date-time)	Returns merge requests deployed before the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`deployed_after` Query	String (date-time)	Returns merge requests deployed after the given date/time. Expected in ISO 8601 format Example: `2019-03-15T08:00:00Z`
`environment` Query	String	Returns merge requests deployed to the given environment Example: `production`
`merge_user_id` Query	Integer	Returns merge requests which have been merged by the user with the given user `id`. Mutually exclusive with `merge_user_username`
`merge_user_username` Query	String	Returns merge requests which have been merged by the user with the given `username`. Mutually exclusive with `merge_user_id`
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`iids` Query	Array of integers	Returns the request having the given `iid`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestBasic
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—
`422`	Unprocessable entity	—

Create a merge request

POST /api/v4/projects/{id}/merge_requests

Creates a merge request for a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`add_labels`	Array of strings	Comma-separated label names to add to a merge request
`allow_collaboration`	Boolean	Allow commits from members who can merge to the target branch
`allow_maintainer_to_push`	Boolean	[deprecated] See allow_collaboration
`assignee_id`	Integer	Assignee user ID
`assignee_ids`	Array of integers	The IDs of the users to assign the merge request to, as a comma-separated list. Set to 0 or provide an empty value to unassign all assignees
`description`	String	Description of the merge request. Limited to 1,048,576 characters
`labels`	Array of strings	Comma-separated label names for a merge request. Set to an empty string to unassign all labels
`merge_after`	String	Date after which the merge request can be merged
`milestone`	String	The title of a project or ancestor-group milestone to assign the merge request to. Mutually exclusive with `milestone_id` Maximum length: `255`
`milestone_id`	Integer	The global ID of a milestone to assign the merge request to. Mutually exclusive with `milestone`
`remove_labels`	Array of strings	Comma-separated label names to remove from a merge request
`remove_source_branch`	Boolean	Flag indicating if a merge request should remove the source branch when merging
`reviewer_ids`	Array of integers	The IDs of the users to review the merge request, as a comma-separated list. Set to 0 or provide an empty value to unassign all reviewers
`source_branch` Required	String	The source branch
`squash`	Boolean	Squash commits into a single commit when merging
`target_branch` Required	String	The target branch
`target_project_id`	Integer	The target project of the merge request defaults to the :id of the project
`title` Required	String	The title of the merge request

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMergeRequest
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`409`	Conflict	—
`422`	Unprocessable entity	—

Retrieve a merge request

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}

Retrieves a merge request for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request
`render_html` Query	Boolean	If `true`, response includes rendered HTML for title and description
`include_diverged_commits_count` Query	Boolean	If `true`, response includes the commits behind the target branch
`include_rebase_in_progress` Query	Boolean	If `true`, response includes whether a rebase operation is in progress

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequest
`400`	Bad Request	—
`404`	Not found	—

Update a merge request

PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}

Updates a merge request for a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`add_labels`	Array of strings	Comma-separated label names to add to a merge request
`allow_collaboration`	Boolean	Allow commits from members who can merge to the target branch
`allow_maintainer_to_push`	Boolean	[deprecated] See allow_collaboration
`assignee_id`	Integer	Assignee user ID
`assignee_ids`	Array of integers	The IDs of the users to assign the merge request to, as a comma-separated list. Set to 0 or provide an empty value to unassign all assignees
`description`	String	Description of the merge request. Limited to 1,048,576 characters
`discussion_locked`	Boolean	Flag indicating if the merge request’s discussion is locked. If the discussion is locked only project members can add, edit or resolve comments
`labels`	Array of strings	Comma-separated label names for a merge request. Set to an empty string to unassign all labels
`merge_after`	String	Date after which the merge request can be merged
`milestone`	String	The title of a project or ancestor-group milestone to assign the merge request to. Mutually exclusive with `milestone_id` Maximum length: `255`
`milestone_id`	Integer	The global ID of a milestone to assign the merge request to. Mutually exclusive with `milestone`
`remove_labels`	Array of strings	Comma-separated label names to remove from a merge request
`remove_source_branch`	Boolean	Flag indicating if a merge request should remove the source branch when merging
`reviewer_ids`	Array of integers	The IDs of the users to review the merge request, as a comma-separated list. Set to 0 or provide an empty value to unassign all reviewers
`squash`	Boolean	Squash commits into a single commit when merging
`state_event`	String	New state (close/reopen) Allowed values: `close`, `reopen`
`target_branch`	String	The target branch
`title`	String	The title of the merge request

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequest
`400`	Bad request	—
`404`	Not found	—
`409`	Conflict	—
`422`	Unprocessable entity	—

Delete a merge request

DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}

Deletes a specified merge request for a project. Administrators and project Owners only.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—
`412`	Precondition failed	—

Add spent time for a merge request

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/add_spent_time

Adds spent time for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge_request

Request body (application/json)

Property	Type	Description
`duration` Required	String	The duration in human format

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssuableTimeStats
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Cancel merge when pipeline succeeds

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/cancel_merge_when_pipeline_succeeds

Cancels an automatic merge for a merge request that has been set to merge when the pipeline succeeds.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMergeRequest
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—
`405`	Method not allowed	—
`406`	Not acceptable	—

Retrieve merge request changes

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/changes

Retrieves changes for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`unidiff` Query	Boolean	A diff in a Unified diff format Default: `false`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestChanges
`400`	Bad Request	—
`404`	Not found	—

List all issues that close on merge

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/closes_issues

Lists all issues that close on merge.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMRNote
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Retrieve merge request commits

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/commits

Retrieves commits for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCommit
`400`	Bad Request	—
`404`	Not found	—

List all context commits for a merge request

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commits

Lists all context commits for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCommit
`400`	Bad Request	—
`404`	Not found	—

Create context commits for a merge request

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commits

Creates context commits for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`commits` Required	Array of strings	The context commits’ SHA

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCommit
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Delete context commits from a merge request

DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/context_commits

Deletes specified context commits from a merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`commits` Query, required	Array of strings	The context commits’ SHA
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

List all merge request diffs

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/diffs

Lists all merge request diffs.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`unidiff` Query	Boolean	A diff in a Unified diff format Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesDiff
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Merge a merge request

PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/merge

Merges a merge request. Accepts and merges changes submitted with the merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`auto_merge`	Boolean	If `true`, the merge request is set to auto merge
`merge_commit_message`	String	Custom merge commit message
`merge_when_pipeline_succeeds`	Boolean	Deprecated: Use auto_merge instead
`sha`	String	If present, then this SHA must match the HEAD of the source branch, otherwise the merge fails
`should_remove_source_branch`	Boolean	If `true`, removes the source branch
`skip_merge_train`	Boolean	If `true`, avoids restarting the merge train when merging immediately
`squash`	Boolean	If `true`, the commits are squashed into a single commit on merge
`squash_commit_message`	String	Custom squash commit message

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequest
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—
`405`	Method not allowed	—
`409`	Conflict	—
`422`	Unprocessable entity	—

Merge to default merge ref path

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/merge_ref

Merges the changes between the merge request source and target branches into the refs/merge-requests/:iid/merge ref, of the target project repository, if possible. This ref has the state the target branch would have if a regular merge action was taken.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad request	—
`404`	Not Found	—

Retrieve merge request participants

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/participants

Retrieves participants for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesUserBasic
`400`	Bad Request	—
`404`	Not found	—

List all merge request pipelines

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelines

Lists all merge request pipelines.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request

Responses

Code	Description	Schema
`200`	OK	APIEntitiesCiPipelineBasic
`400`	Bad Request	—
`404`	Not found	—

Create a merge request pipeline

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/pipelines

Creates a merge request pipeline. Pipelines created with this operation must configure .gitlab-ci.yml with only: [merge_requests] to create jobs.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`async`	Boolean	Indicates if the merge request pipeline creation should be performed asynchronously. If set to `true`, the pipeline will be created outside of the API request and the endpoint will return an empty response with a `202` status code. When the response is `202`, the creation can still fail outside of this request Default: `false`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesCiPipeline
`400`	Bad request	—
`404`	Not found	—
`405`	Method not allowed	—

Retrieve merge request raw diffs

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/raw_diffs

Retrieves the raw diffs of the files changed in a merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Rebase a merge request

PUT /api/v4/projects/{id}/merge_requests/{merge_request_iid}/rebase

Rebases a merge request. Automatically rebases the source_branch of the merge request against its target_branch.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`skip_ci`	Boolean	Set to true to skip creating a CI pipeline

Responses

Code	Description	Schema
`202`	Accepted	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—
`409`	Conflict	—

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/related_issues

Lists all issues related to the merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`403`	Forbidden	—
`404`	Not found	—

Reset spent time for a merge request

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_spent_time

Resets the total spent time for a specified merge request to 0 seconds.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge_request

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssuableTimeStats
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Reset the estimated time for a merge request

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reset_time_estimate

Resets the estimated time for a specified merge request to 0 seconds.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge_request

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssuableTimeStats
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve merge request reviewers

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/reviewers

Retrieves reviewers for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestReviewer
`400`	Bad Request	—
`404`	Not found	—

Set the estimated time for a merge request

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/time_estimate

Sets an estimated time of work for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge_request

Request body (application/json)

Property	Type	Description
`duration` Required	String	The duration in human format Example: `3h30m`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesIssuableTimeStats
`400`	Bad request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve time tracking stats for a merge request

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/time_stats

Retrieves time tracking stats for a specified merge request, including time estimate and time spent in seconds and human-readable format (for example, 1h 30m).

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge_request

Responses

Code	Description	Schema
`200`	OK	APIEntitiesIssuableTimeStats
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not found	—

Retrieve merge request diff versions

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/versions

Retrieves merge request diff versions.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestDiff
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a merge request diff version

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/versions/{version_id}

Retrieves a merge request diff version.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	The internal ID of the merge request
`version_id` Path, required	Integer	The ID of the merge request diff version
`unidiff` Query	Boolean	A diff in a Unified diff format Default: `false`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMergeRequestDiffFull
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesCiPipeline

Property	Type	Description
`archived`	Boolean	Example: `false`
`before_sha`	String	Example: `a91957a858320c0e17f3a0eca7cfacbff50ea29a`
`committed_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`coverage`	Number (float)	Example: `98.29`
`created_at`	String (date-time)	Example: `2015-12-24T15:51:21.880Z`
`detailed_status`	DetailedStatusEntity	—
`duration`	Integer	Time spent running in seconds Example: `127`
`finished_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`project_id`	Integer (int64)	Example: `3`
`queued_duration`	Integer	Time spent enqueued in seconds Example: `63`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`started_at`	String (date-time)	Example: `2015-12-24T17:54:30.733Z`
`status`	String	Example: `success`
`tag`	Boolean	Example: `false`
`updated_at`	String (date-time)	Example: `2015-12-24T17:54:31.198Z`
`user`	APIEntitiesUserBasic	—
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`
`yaml_errors`	String	Example: `widgets:build: needs 'widgets:test'`

APIEntitiesCiPipelineBasic

Property	Type	Description
`created_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`id`	Integer (int64)	Example: `1`
`iid`	Integer	Example: `2`
`project_id`	Integer (int64)	Example: `3`
`ref`	String	Example: `feature-branch`
`sha`	String	Example: `0ec9e58fdfca6cdd6652c083c9edb53abc0bad52`
`source`	String	Example: `push`
`status`	String	Example: `success`
`updated_at`	String (date-time)	Example: `2022-10-21T16:49:48.000+02:00`
`web_url`	String	Example: `https://gitlab.example.com/gitlab-org/gitlab-foss/-/pipelines/61`

APIEntitiesCommit

Property	Type	Description
`author_email`	String	Example: `john@example.com`
`author_name`	String	Example: `John Smith`
`authored_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committed_date`	String (date-time)	Example: `2012-05-28T04:42:42-07:00`
`committer_email`	String	Example: `jack@example.com`
`committer_name`	String	Example: `Jack Smith`
`created_at`	String (date-time)	Example: `2017-07-26T11:08:53.000+02:00`
`extended_trailers`	Object	Example: `{"Signed-off-by":["John Doe \u003cjohndoe@gitlab.com\u003e","Jane Doe \u003cjanedoe@gitlab.com\u003e"]}`
`id`	String	Example: `2695effb5807a22ff3d138d593fd856244e155e7`
`message`	String	Example: `Initial commit`
`parent_ids`	Array of strings	Example: `["2a4b78934375d7f53875269ffd4f45fd83a84ebe"]`
`short_id`	String	Example: `2695effb`
`title`	String	Example: `Initial commit`
`trailers`	Object	Example: `{"Merged-By":"Jane Doe janedoe@gitlab.com"}`
`web_url`	String	Example: `https://gitlab.example.com/janedoe/gitlab-foss/-/commit/ed899a2f4b50b4370feeea94676502b42383c746`

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesDiff

Property	Type	Description
`a_mode`	String	Example: `100755`
`b_mode`	String	Example: `100644`
`collapsed`	Boolean	—
`deleted_file`	Boolean	—
`diff`	String	Example: `@@ -71,6 +71,8 @@\n...`
`generated_file`	Boolean	—
`new_file`	Boolean	—
`new_path`	String	Example: `doc/update/5.4-to-6.0.md`
`old_path`	String	Example: `doc/update/5.4-to-6.0.md`
`renamed_file`	Boolean	—
`too_large`	Boolean	—

APIEntitiesDiffRefs

Property	Type	Description
`base_sha`	String	Example: `b83d6e391c22777fca1ed3012fce84f633d7fed0`
`head_sha`	String	Example: `b83d6e391c22777fca1ed3012fce84f633d7fed0`
`start_sha`	String	Example: `b83d6e391c22777fca1ed3012fce84f633d7fed0`

APIEntitiesIssuableReferences

Property	Type	Description
`full`	String	Example: `test&6`
`relative`	String	Example: `&6`
`short`	String	Example: `&6`

APIEntitiesIssuableTimeStats

Property	Type	Description
`human_time_estimate`	String	Example: `3h 30m`
`human_total_time_spent`	String	Example: `1h`
`time_estimate`	Integer	Example: `12600`
`total_time_spent`	Integer	Example: `3600`

APIEntitiesMergeRequest

Property	Type	Description
`allow_collaboration`	Boolean	—
`allow_maintainer_to_push`	Boolean	—
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`blocking_discussions_resolved`	Boolean	—
`changes_count`	String	Example: `1`
`closed_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`closed_by`	APIEntitiesUserBasic	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`description_html`	String	—
`detailed_merge_status`	String	Example: `mergeable`
`diff_refs`	APIEntitiesDiffRefs	—
`discussion_locked`	Boolean	—
`diverged_commits_count`	Integer	Example: `0`
`downvotes`	Integer	—
`draft`	Boolean	—
`first_contribution`	Boolean	—
`first_deployed_to_production_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`force_remove_source_branch`	Boolean	—
`has_conflicts`	Boolean	—
`head_pipeline`	APIEntitiesCiPipeline	—
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	—
`imported_from`	String	Example: `bitbucket`
`labels`	Array of strings	—
`latest_build_finished_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`latest_build_started_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_after`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_commit_sha`	String	Example: `1234abcd`
`merge_error`	String	Example: `Merge error`
`merge_status`	String	Example: `unchecked`
`merge_user`	APIEntitiesUserBasic	—
`merge_when_pipeline_succeeds`	Boolean	—
`merged_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merged_by`	APIEntitiesUserBasic	—
`milestone`	APIEntitiesMilestone	—
`pipeline`	APIEntitiesCiPipelineBasic	—
`prepared_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`project_id`	Integer (int64)	Example: `4`
`rebase_in_progress`	Boolean	—
`reference`	String	Example: `!1`
`references`	APIEntitiesIssuableReferences	—
`reviewers`	APIEntitiesUserBasic	—
`sha`	String	Example: `1234abcd`
`should_remove_source_branch`	Boolean	—
`source_branch`	String	—
`source_project_id`	Integer (int64)	—
`squash`	Boolean	—
`squash_commit_sha`	String	Example: `1234abcd`
`squash_on_merge`	Boolean	—
`state`	String	Example: `closed`
`subscribed`	Boolean	—
`target_branch`	String	—
`target_project_id`	Integer (int64)	—
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`title_html`	String	—
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user`	Object	—
`user.can_merge`	Boolean	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `https://gitlab.example.com/my-group/my-project/-/merge_requests/1`
`work_in_progress`	Boolean	—

APIEntitiesMergeRequestBasic

Property	Type	Description
`allow_collaboration`	Boolean	—
`allow_maintainer_to_push`	Boolean	—
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`blocking_discussions_resolved`	Boolean	—
`closed_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`closed_by`	APIEntitiesUserBasic	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`description_html`	String	—
`detailed_merge_status`	String	Example: `mergeable`
`discussion_locked`	Boolean	—
`downvotes`	Integer	—
`draft`	Boolean	—
`force_remove_source_branch`	Boolean	—
`has_conflicts`	Boolean	—
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	—
`imported_from`	String	Example: `bitbucket`
`labels`	Array of strings	—
`merge_after`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_commit_sha`	String	Example: `1234abcd`
`merge_status`	String	Example: `unchecked`
`merge_user`	APIEntitiesUserBasic	—
`merge_when_pipeline_succeeds`	Boolean	—
`merged_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merged_by`	APIEntitiesUserBasic	—
`milestone`	APIEntitiesMilestone	—
`prepared_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`project_id`	Integer (int64)	Example: `4`
`reference`	String	Example: `!1`
`references`	APIEntitiesIssuableReferences	—
`reviewers`	APIEntitiesUserBasic	—
`sha`	String	Example: `1234abcd`
`should_remove_source_branch`	Boolean	—
`source_branch`	String	—
`source_project_id`	Integer (int64)	—
`squash`	Boolean	—
`squash_commit_sha`	String	Example: `1234abcd`
`squash_on_merge`	Boolean	—
`state`	String	Example: `closed`
`target_branch`	String	—
`target_project_id`	Integer (int64)	—
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`title_html`	String	—
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `https://gitlab.example.com/my-group/my-project/-/merge_requests/1`
`work_in_progress`	Boolean	—

APIEntitiesMergeRequestChanges

Property	Type	Description
`allow_collaboration`	Boolean	—
`allow_maintainer_to_push`	Boolean	—
`assignee`	APIEntitiesUserBasic	—
`assignees`	APIEntitiesUserBasic	—
`author`	APIEntitiesUserBasic	—
`blocking_discussions_resolved`	Boolean	—
`changes`	Array of APIEntitiesDiff	—
`changes_count`	String	Example: `1`
`closed_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`closed_by`	APIEntitiesUserBasic	—
`created_at`	String (date-time)	Example: `2022-08-17T12:46:35.053Z`
`description`	String	Example: `Repellendus impedit et vel velit dignissimos.`
`description_html`	String	—
`detailed_merge_status`	String	Example: `mergeable`
`diff_refs`	APIEntitiesDiffRefs	—
`discussion_locked`	Boolean	—
`diverged_commits_count`	Integer	Example: `0`
`downvotes`	Integer	—
`draft`	Boolean	—
`first_contribution`	Boolean	—
`first_deployed_to_production_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`force_remove_source_branch`	Boolean	—
`has_conflicts`	Boolean	—
`head_pipeline`	APIEntitiesCiPipeline	—
`id`	Integer (int64)	Example: `84`
`iid`	Integer	Example: `14`
`imported`	Boolean	—
`imported_from`	String	Example: `bitbucket`
`labels`	Array of strings	—
`latest_build_finished_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`latest_build_started_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_after`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merge_commit_sha`	String	Example: `1234abcd`
`merge_error`	String	Example: `Merge error`
`merge_status`	String	Example: `unchecked`
`merge_user`	APIEntitiesUserBasic	—
`merge_when_pipeline_succeeds`	Boolean	—
`merged_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`merged_by`	APIEntitiesUserBasic	—
`milestone`	APIEntitiesMilestone	—
`overflow`	Boolean	—
`pipeline`	APIEntitiesCiPipelineBasic	—
`prepared_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`project_id`	Integer (int64)	Example: `4`
`rebase_in_progress`	Boolean	—
`reference`	String	Example: `!1`
`references`	APIEntitiesIssuableReferences	—
`reviewers`	APIEntitiesUserBasic	—
`sha`	String	Example: `1234abcd`
`should_remove_source_branch`	Boolean	—
`source_branch`	String	—
`source_project_id`	Integer (int64)	—
`squash`	Boolean	—
`squash_commit_sha`	String	Example: `1234abcd`
`squash_on_merge`	Boolean	—
`state`	String	Example: `closed`
`subscribed`	Boolean	—
`target_branch`	String	—
`target_project_id`	Integer (int64)	—
`task_completion_status`	APIEntitiesTaskCompletionStatus	—
`time_stats`	APIEntitiesIssuableTimeStats	—
`title`	String	Example: `Impedit et ut et dolores vero provident ullam est`
`title_html`	String	—
`updated_at`	String (date-time)	Example: `2022-11-14T17:22:01.470Z`
`upvotes`	Integer	—
`user`	Object	—
`user.can_merge`	Boolean	—
`user_notes_count`	Integer	—
`web_url`	String	Example: `https://gitlab.example.com/my-group/my-project/-/merge_requests/1`
`work_in_progress`	Boolean	—

APIEntitiesMergeRequestDiff

Property	Type	Description
`base_commit_sha`	String	Example: `1234abcd`
`created_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`head_commit_sha`	String	Example: `1234abcd`
`id`	Integer (int64)	Example: `1`
`merge_request_id`	Integer (int64)	Example: `1`
`patch_id_sha`	String	Example: `1234abcd`
`real_size`	String	Example: `1`
`start_commit_sha`	String	Example: `1234abcd`
`state`	String	Example: `collected`

APIEntitiesMergeRequestDiffFull

Property	Type	Description
`base_commit_sha`	String	Example: `1234abcd`
`commits`	Array of APIEntitiesCommit	—
`created_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`diffs`	Array of APIEntitiesDiff	—
`head_commit_sha`	String	Example: `1234abcd`
`id`	Integer (int64)	Example: `1`
`merge_request_id`	Integer (int64)	Example: `1`
`patch_id_sha`	String	Example: `1234abcd`
`real_size`	String	Example: `1`
`start_commit_sha`	String	Example: `1234abcd`
`state`	String	Example: `collected`

APIEntitiesMergeRequestReviewer

Property	Type	Description
`created_at`	String (date-time)	Example: `2022-01-31T15:10:45.080Z`
`state`	String	Example: `unreviewed`
`user`	APIEntitiesUserBasic	—

APIEntitiesMilestone

Property	Type	Description
`created_at`	String	—
`description`	String	—
`due_date`	String	—
`expired`	Boolean	—
`group_id`	String	—
`id`	Integer (int64)	—
`iid`	Integer (int64)	—
`project_id`	Integer (int64)	—
`start_date`	String	—
`state`	String	—
`title`	String	—
`updated_at`	String	—
`web_url`	String	—

APIEntitiesMRNote

Property	Type	Description
`author`	APIEntitiesUserBasic	—
`note`	String	Example: `LGTM!`

APIEntitiesTaskCompletionStatus

Property	Type	Description
`completed_count`	Integer	Example: `3`
`count`	Integer	Example: `5`

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

DetailedStatusEntity

Property	Type	Description
`action`	Object	—
`action.button_title`	String	Example: `Cancel this job`
`action.confirmation_message`	String	Example: `Are you sure?`
`action.icon`	String	Example: `cancel`
`action.method`	String	Example: `post`
`action.path`	String	Example: `/namespace1/project1/-/jobs/2/cancel`
`action.title`	String	Example: `Cancel`
`details_path`	String	Example: `/test-group/test-project/-/pipelines/287`
`favicon`	String	Example: `/assets/ci_favicons/favicon_status_success.png`
`group`	String	Example: `success`
`has_details`	Boolean	Example: `true`
`icon`	String	Example: `status_success`
`illustration`	Object	Example: `{"content":"This job depends on upstream jobs that need to succeed in order for this job to be triggered","image":"illustrations/empty-state/empty-job-not-triggered-md.svg","size":"","title":"This job has not been triggered yet"}`
`label`	String	Example: `passed`
`text`	String	Example: `passed`
`tooltip`	String	Example: `passed`

List all group merge requests

List all merge requests

List all project merge requests

Create a merge request

Retrieve a merge request

Update a merge request

Delete a merge request

Add spent time for a merge request

Cancel merge when pipeline succeeds

Retrieve merge request changes

List all issues that close on merge

Retrieve merge request commits

List all context commits for a merge request

Create context commits for a merge request

Delete context commits from a merge request

List all merge request diffs

Merge a merge request

Merge to default merge ref path

Retrieve merge request participants

List all merge request pipelines

Create a merge request pipeline

Retrieve merge request raw diffs

Rebase a merge request

List all issues related to the merge request

Reset spent time for a merge request

Reset the estimated time for a merge request

Retrieve merge request reviewers

Set the estimated time for a merge request

Retrieve time tracking stats for a merge request

Retrieve merge request diff versions

Retrieve a merge request diff version

Schemas

APIEntitiesCiPipeline

APIEntitiesCiPipelineBasic

APIEntitiesCommit

APIEntitiesCustomAttribute

APIEntitiesDiff

APIEntitiesDiffRefs

APIEntitiesIssuableReferences

APIEntitiesIssuableTimeStats

APIEntitiesMergeRequest

APIEntitiesMergeRequestBasic

APIEntitiesMergeRequestChanges

APIEntitiesMergeRequestDiff

APIEntitiesMergeRequestDiffFull

APIEntitiesMergeRequestReviewer

APIEntitiesMilestone

APIEntitiesMRNote

APIEntitiesTaskCompletionStatus

APIEntitiesUserBasic

DetailedStatusEntity

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error