The reference attribute in responses is deprecated in favor of references.
The references.relative attribute is relative to the group or project of the issue being requested.
When an issue is fetched from its project, the relative format is the same as the short format.
When requested across groups or projects, it’s expected to be the same as the full format.
Return issues assigned to the given user id. Mutually exclusive with assignee_username. None returns unassigned issues. Any returns issues with an assignee.
assignee_username
string array
no
Return issues assigned to the given username. Similar to assignee_id and mutually exclusive with assignee_id. In GitLab CE, the assignee_username array should only contain a single value. Otherwise, an invalid parameter error is returned.
author_id
integer
no
Return issues created by the given user id. Mutually exclusive with author_username. Combine with scope=all or scope=assigned_to_me.
author_username
string
no
Return issues created by the given username. Similar to author_id and mutually exclusive with author_id.
confidential
boolean
no
Filter confidential or public issues.
created_after
datetime
no
Return issues created on or after the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z)
created_before
datetime
no
Return issues created on or before the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z)
due_date
string
no
Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: 0 (no due date), any, today, tomorrow, overdue, week, month, next_month_and_previous_two_weeks.
epic_id
integer
no
Return issues associated with the given epic ID. None returns issues that are not associated with an epic. Any returns issues that are associated with an epic. (
Returns issues assigned to milestones with a given timebox value (None, Any, Upcoming, and Started). None lists all issues with no milestone. Any lists all issues that have an assigned milestone. Upcoming lists all issues assigned to milestones due in the future. Started lists all issues assigned to open, started milestones. milestone and milestone_id are mutually exclusive. (
GET /groups/:id/issues
GET /groups/:id/issues?assignee_id=5
GET /groups/:id/issues?author_id=5
GET /groups/:id/issues?confidential=true
GET /groups/:id/issues?iids[]=42&iids[]=43
GET /groups/:id/issues?labels=foo
GET /groups/:id/issues?labels=foo,bar
GET /groups/:id/issues?labels=foo,bar&state=opened
GET /groups/:id/issues?milestone=1.0.0
GET /groups/:id/issues?milestone=1.0.0&state=opened
GET /groups/:id/issues?my_reaction_emoji=star
GET /groups/:id/issues?search=issue+title+or+description
GET /groups/:id/issues?state=closed
GET /groups/:id/issues?state=opened
Attribute
Type
Required
Description
assignee_id
integer
no
Return issues assigned to the given user id. Mutually exclusive with assignee_username. None returns unassigned issues. Any returns issues with an assignee.
assignee_username
string array
no
Return issues assigned to the given username. Similar to assignee_id and mutually exclusive with assignee_id. In GitLab CE, the assignee_username array should only contain a single value. Otherwise, an invalid parameter error is returned.
author_id
integer
no
Return issues created by the given user id. Mutually exclusive with author_username. Combine with scope=all or scope=assigned_to_me.
author_username
string
no
Return issues created by the given username. Similar to author_id and mutually exclusive with author_id.
confidential
boolean
no
Filter confidential or public issues.
created_after
datetime
no
Return issues created on or after the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z)
created_before
datetime
no
Return issues created on or before the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z)
due_date
string
no
Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: 0 (no due date), any, today, tomorrow, overdue, week, month, next_month_and_previous_two_weeks.
epic_id
integer
no
Return issues associated with the given epic ID. None returns issues that are not associated with an epic. Any returns issues that are associated with an epic. (
GET /projects/:id/issues
GET /projects/:id/issues?assignee_id=5
GET /projects/:id/issues?author_id=5
GET /projects/:id/issues?confidential=true
GET /projects/:id/issues?iids[]=42&iids[]=43
GET /projects/:id/issues?labels=foo
GET /projects/:id/issues?labels=foo,bar
GET /projects/:id/issues?labels=foo,bar&state=opened
GET /projects/:id/issues?milestone=1.0.0
GET /projects/:id/issues?milestone=1.0.0&state=opened
GET /projects/:id/issues?my_reaction_emoji=star
GET /projects/:id/issues?search=issue+title+or+description
GET /projects/:id/issues?state=closed
GET /projects/:id/issues?state=opened
Attribute
Type
Required
Description
assignee_id
integer
no
Return issues assigned to the given user id. Mutually exclusive with assignee_username. None returns unassigned issues. Any returns issues with an assignee.
assignee_username
string array
no
Return issues assigned to the given username. Similar to assignee_id and mutually exclusive with assignee_id. In GitLab CE, the assignee_username array should only contain a single value. Otherwise, an invalid parameter error is returned.
author_id
integer
no
Return issues created by the given user id. Mutually exclusive with author_username. Combine with scope=all or scope=assigned_to_me.
author_username
string
no
Return issues created by the given username. Similar to author_id and mutually exclusive with author_id.
confidential
boolean
no
Filter confidential or public issues.
created_after
datetime
no
Return issues created on or after the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z)
created_before
datetime
no
Return issues created on or before the given time. Expected in ISO 8601 format (2019-03-15T08:00:00Z)
due_date
string
no
Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: 0 (no due date), any, today, tomorrow, overdue, week, month, next_month_and_previous_two_weeks.
epic_id
integer
no
Return issues associated with the given epic ID. None returns issues that are not associated with an epic. Any returns issues that are associated with an epic. (
{"id":1,"milestone":{"due_date":null,"project_id":4,"state":"closed","description":"Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.","iid":3,"id":11,"title":"v3.0","created_at":"2016-01-04T15:31:39.788Z","updated_at":"2016-01-04T15:31:39.788Z","closed_at":"2016-01-05T15:31:46.176Z"},"author":{"state":"active","web_url":"https://gitlab.example.com/root","avatar_url":null,"username":"root","id":1,"name":"Administrator"},"description":"Omnis vero earum sunt corporis dolor et placeat.","state":"closed","iid":1,"assignees":[{"avatar_url":null,"web_url":"https://gitlab.example.com/lennie","state":"active","username":"lennie","id":9,"name":"Dr. Luella Kovacek"}],"assignee":{"avatar_url":null,"web_url":"https://gitlab.example.com/lennie","state":"active","username":"lennie","id":9,"name":"Dr. Luella Kovacek"},"type":"ISSUE","labels":[],"upvotes":4,"downvotes":0,"merge_requests_count":0,"title":"Ut commodi ullam eos dolores perferendis nihil sunt.","updated_at":"2016-01-04T15:31:46.176Z","created_at":"2016-01-04T15:31:46.176Z","closed_at":null,"closed_by":null,"subscribed":false,"user_notes_count":1,"due_date":null,"web_url":"http://example.com/my-group/my-project/issues/1","references":{"short":"#1","relative":"#1","full":"my-group/my-project#1"},"time_stats":{"time_estimate":0,"total_time_spent":0,"human_time_estimate":null,"human_total_time_spent":null},"confidential":false,"discussion_locked":false,"issue_type":"issue","severity":"UNKNOWN","task_completion_status":{"count":0,"completed_count":0},"weight":null,"has_tasks":false,"_links":{"self":"http://gitlab.example:3000/api/v4/projects/1/issues/1","notes":"http://gitlab.example:3000/api/v4/projects/1/issues/1/notes","award_emoji":"http://gitlab.example:3000/api/v4/projects/1/issues/1/award_emoji","project":"http://gitlab.example:3000/api/v4/projects/1"},"moved_to_id":null,"service_desk_reply_to":"service.desk@gitlab.com"}
Issues created by users on GitLab Premium or higher include the weight property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","weight":null,...}
Issues created by users on GitLab Premium or higher include the epic property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","epic":{"epic_iid":5,//deprecated,use`iid`ofthe`epic`attribute"epic":{"id":42,"iid":5,"title":"My epic epic","url":"/groups/h5bp/-/epics/5","group_id":8},...}
If the project is private or the issue is confidential, you need to provide credentials to authorize.
The preferred way to do this, is by using personal access tokens.
{"project_id":4,"milestone":{"due_date":null,"project_id":4,"state":"closed","description":"Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.","iid":3,"id":11,"title":"v3.0","created_at":"2016-01-04T15:31:39.788Z","updated_at":"2016-01-04T15:31:39.788Z","closed_at":"2016-01-05T15:31:46.176Z"},"author":{"state":"active","web_url":"https://gitlab.example.com/root","avatar_url":null,"username":"root","id":1,"name":"Administrator"},"description":"Omnis vero earum sunt corporis dolor et placeat.","state":"closed","iid":1,"assignees":[{"avatar_url":null,"web_url":"https://gitlab.example.com/lennie","state":"active","username":"lennie","id":9,"name":"Dr. Luella Kovacek"}],"assignee":{"avatar_url":null,"web_url":"https://gitlab.example.com/lennie","state":"active","username":"lennie","id":9,"name":"Dr. Luella Kovacek"},"type":"ISSUE","labels":[],"upvotes":4,"downvotes":0,"merge_requests_count":0,"id":41,"title":"Ut commodi ullam eos dolores perferendis nihil sunt.","updated_at":"2016-01-04T15:31:46.176Z","created_at":"2016-01-04T15:31:46.176Z","closed_at":null,"closed_by":null,"subscribed":false,"user_notes_count":1,"due_date":null,"web_url":"http://gitlab.example.com/my-group/my-project/issues/1","references":{"short":"#1","relative":"#1","full":"my-group/my-project#1"},"time_stats":{"time_estimate":0,"total_time_spent":0,"human_time_estimate":null,"human_total_time_spent":null},"confidential":false,"discussion_locked":false,"issue_type":"issue","severity":"UNKNOWN","_links":{"self":"http://gitlab.example.com/api/v4/projects/1/issues/2","notes":"http://gitlab.example.com/api/v4/projects/1/issues/2/notes","award_emoji":"http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji","project":"http://gitlab.example.com/api/v4/projects/1"},"task_completion_status":{"count":0,"completed_count":0}}
Issues created by users on GitLab Premium or higher include the weight property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","weight":null,...}
Issues created by users on GitLab Premium or higher include the epic property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","epic_iid":5,//deprecated,use`iid`ofthe`epic`attribute"epic":{"id":42,"iid":5,"title":"My epic epic","url":"/groups/h5bp/-/epics/5","group_id":8},...}
The weight property moved to GitLab Premium in 13.9.
Creates a new project issue.
POST /projects/:id/issues
Attribute
Type
Required
Description
assignee_id
integer
no
The ID of the user to assign the issue to. Only appears on GitLab Free.
assignee_ids
integer array
no
The IDs of the users to assign the issue to.
confidential
boolean
no
Set an issue to be confidential. Default is false.
created_at
string
no
When the issue was created. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
description
string
no
The description of an issue. Limited to 1,048,576 characters.
discussion_to_resolve
string
no
The ID of a discussion to resolve. This fills out the issue with a default description and mark the discussion as resolved. Use in combination with merge_request_to_resolve_discussions_of.
due_date
string
no
The due date. Date time string in the format YYYY-MM-DD, for example 2016-03-11
epic_id
integer
no
ID of the epic to add the issue to. Valid values are greater than or equal to 0.
epic_iid
integer
no
IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated,
The internal ID of the project’s issue (requires administrator or project owner rights)
issue_type
string
no
The type of issue. One of issue, incident, or test_case. Default is issue.
labels
string
no
Comma-separated label names for an issue
merge_request_to_resolve_discussions_of
integer
no
The IID of a merge request in which to resolve all issues. This fills out the issue with a default description and mark all discussions as resolved. When passing a description or title, these values take precedence over the default values.
milestone_id
integer
no
The global ID of a milestone to assign issue. To find the milestone_id associated with a milestone, view an issue with the milestone assigned and use the API to retrieve the issue’s details.
title
string
yes
The title of an issue
weight
integer
no
The weight of the issue. Valid values are greater than or equal to 0.
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug"
Example response:
{"project_id":4,"id":84,"created_at":"2016-01-07T12:44:33.959Z","iid":14,"title":"Issues with auth","state":"opened","assignees":[],"assignee":null,"type":"ISSUE","labels":["bug"],"upvotes":4,"downvotes":0,"merge_requests_count":0,"author":{"name":"Alexandra Bashirian","avatar_url":null,"state":"active","web_url":"https://gitlab.example.com/eileen.lowe","id":18,"username":"eileen.lowe"},"description":null,"updated_at":"2016-01-07T12:44:33.959Z","closed_at":null,"closed_by":null,"milestone":null,"subscribed":true,"user_notes_count":0,"due_date":null,"web_url":"http://gitlab.example.com/my-group/my-project/issues/14","references":{"short":"#14","relative":"#14","full":"my-group/my-project#14"},"time_stats":{"time_estimate":0,"total_time_spent":0,"human_time_estimate":null,"human_total_time_spent":null},"confidential":false,"discussion_locked":false,"issue_type":"issue","severity":"UNKNOWN","_links":{"self":"http://gitlab.example.com/api/v4/projects/1/issues/2","notes":"http://gitlab.example.com/api/v4/projects/1/issues/2/notes","award_emoji":"http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji","project":"http://gitlab.example.com/api/v4/projects/1"},"task_completion_status":{"count":0,"completed_count":0}}
Issues created by users on GitLab Premium or higher include the weight property:
Issues created by users on GitLab Premium or higher include the epic property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","epic_iid":5,//deprecated,use`iid`ofthe`epic`attribute"epic":{"id":42,"iid":5,"title":"My epic epic","url":"/groups/h5bp/-/epics/5","group_id":8},...}
Issues created by users on GitLab Ultimate include the health_status property:
[{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","health_status":"on_track",...}]
The assignee column is deprecated. We now show it as a single-sized array assignees to conform to the GitLab EE API.
Updates the type of issue. One of issue, incident, or test_case.
labels
string
no
Comma-separated label names for an issue. Set to an empty string to unassign all labels.
milestone_id
integer
no
The global ID of a milestone to assign the issue to. Set to 0 or provide an empty value to unassign a milestone.
remove_labels
string
no
Comma-separated label names to remove from an issue.
state_event
string
no
The state event of an issue. Set close to close the issue and reopen to reopen it
title
string
no
The title of an issue
updated_at
string
no
When the issue was updated. Date time string, ISO 8601 formatted, for example 2016-03-11T03:45:40Z (requires administrator or project owner rights). Empty string or null values are not accepted.
weight
integer
no
The weight of the issue. Valid values are greater than or equal to 0. 0
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/4/issues/85?state_event=close"
Example response:
{"created_at":"2016-01-07T12:46:01.410Z","author":{"name":"Alexandra Bashirian","avatar_url":null,"username":"eileen.lowe","id":18,"state":"active","web_url":"https://gitlab.example.com/eileen.lowe"},"state":"closed","title":"Issues with auth","project_id":4,"description":null,"updated_at":"2016-01-07T12:55:16.213Z","closed_at":"2016-01-08T12:55:16.213Z","closed_by":{"state":"active","web_url":"https://gitlab.example.com/root","avatar_url":null,"username":"root","id":1,"name":"Administrator"},"iid":15,"labels":["bug"],"upvotes":4,"downvotes":0,"merge_requests_count":0,"id":85,"assignees":[],"assignee":null,"milestone":null,"subscribed":true,"user_notes_count":0,"due_date":"2016-07-22","web_url":"http://gitlab.example.com/my-group/my-project/issues/15","references":{"short":"#15","relative":"#15","full":"my-group/my-project#15"},"time_stats":{"time_estimate":0,"total_time_spent":0,"human_time_estimate":null,"human_total_time_spent":null},"confidential":false,"discussion_locked":false,"issue_type":"issue","severity":"UNKNOWN","_links":{"self":"http://gitlab.example.com/api/v4/projects/1/issues/2","notes":"http://gitlab.example.com/api/v4/projects/1/issues/2/notes","award_emoji":"http://gitlab.example.com/api/v4/projects/1/issues/2/award_emoji","project":"http://gitlab.example.com/api/v4/projects/1"},"task_completion_status":{"count":0,"completed_count":0}}
Issues created by users on GitLab Premium or higher include the weight property:
Issues created by users on GitLab Premium or higher include the epic property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","epic_iid":5,//deprecated,use`iid`ofthe`epic`attribute"epic":{"id":42,"iid":5,"title":"My epic epic","url":"/groups/h5bp/-/epics/5","group_id":8},...}
Issues created by users on GitLab Ultimate include the health_status property:
[{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","health_status":"on_track",...}]
The ID of a project’s issue that should be placed after this issue
move_before_id
integer
no
The ID of a project’s issue that should be placed before this issue
curl --request PUT --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/4/issues/85/reorder?move_after_id=51&move_before_id=92"
Move an issue
Moves an issue to a different project. If the target project
is the source project or the user has insufficient permissions,
an error message with status code 400 is returned.
If a given label or milestone with the same name also exists in the target
project, it’s then assigned to the issue being moved.
Issues created by users on GitLab Premium or higher include the epic property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","epic_iid":5,//deprecated,use`iid`ofthe`epic`attribute"epic":{"id":42,"iid":5,"title":"My epic epic","url":"/groups/h5bp/-/epics/5","group_id":8},...}
Issues created by users on GitLab Ultimate include the health_status property:
[{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","health_status":"on_track",...}]
The assignee column is deprecated. We now show it as a single-sized array assignees to conform to the GitLab EE API.
curl --request POST \--header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/1/clone?with_notes=true&to_project_id=6"
Subscribes the authenticated user to an issue to receive notifications.
If the user is already subscribed to the issue, the status code 304
is returned.
Issues created by users on GitLab Premium or higher include the epic property:
{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","epic_iid":5,//deprecated,use`iid`ofthe`epic`attribute"epic":{"id":42,"iid":5,"title":"My epic epic","url":"/groups/h5bp/-/epics/5","group_id":8},...}
Issues created by users on GitLab Ultimate include the health_status property:
[{"project_id":4,"description":"Omnis vero earum sunt corporis dolor et placeat.","health_status":"on_track",...}]
The assignee column is deprecated. We now show it as a single-sized array assignees to conform to the GitLab EE API.
Unsubscribes the authenticated user from the issue to not receive notifications
from it. If the user is not subscribed to the issue, the
status code 304 is returned.
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/93/unsubscribe"
Example response:
{"id":93,"iid":12,"project_id":5,"title":"Incidunt et rerum ea expedita iure quibusdam.","description":"Et cumque architecto sed aut ipsam.","state":"opened","created_at":"2016-04-05T21:41:45.217Z","updated_at":"2016-04-07T13:02:37.905Z","labels":[],"upvotes":4,"downvotes":0,"merge_requests_count":0,"milestone":null,"assignee":{"name":"Edwardo Grady","username":"keyon","id":21,"state":"active","avatar_url":"http://www.gravatar.com/avatar/3e6f06a86cf27fa8b56f3f74f7615987?s=80&d=identicon","web_url":"https://gitlab.example.com/keyon"},"type":"ISSUE","closed_at":null,"closed_by":null,"author":{"name":"Vivian Hermann","username":"orville","id":11,"state":"active","avatar_url":"http://www.gravatar.com/avatar/5224fd70153710e92fb8bcf79ac29d67?s=80&d=identicon","web_url":"https://gitlab.example.com/orville"},"subscribed":false,"due_date":null,"web_url":"http://gitlab.example.com/my-group/my-project/issues/12","references":{"short":"#12","relative":"#12","full":"my-group/my-project#12"},"confidential":false,"discussion_locked":false,"issue_type":"issue","severity":"UNKNOWN","task_completion_status":{"count":0,"completed_count":0}}
Create a to-do item
Manually creates a to-do item for the current user on an issue. If
there already exists a to-do item for the user on that issue, status code 304 is
returned.
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/93/todo"
Example response:
{"id":112,"project":{"id":5,"name":"GitLab CI/CD","name_with_namespace":"GitLab Org / GitLab CI/CD","path":"gitlab-ci","path_with_namespace":"gitlab-org/gitlab-ci"},"author":{"name":"Administrator","username":"root","id":1,"state":"active","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"https://gitlab.example.com/root"},"action_name":"marked","target_type":"Issue","target":{"id":93,"iid":10,"project_id":5,"title":"Vel voluptas atque dicta mollitia adipisci qui at.","description":"Tempora laboriosam sint magni sed voluptas similique.","state":"closed","created_at":"2016-06-17T07:47:39.486Z","updated_at":"2016-07-01T11:09:13.998Z","labels":[],"milestone":{"id":26,"iid":1,"project_id":5,"title":"v0.0","description":"Accusantium nostrum rerum quae quia quis nesciunt suscipit id.","state":"closed","created_at":"2016-06-17T07:47:33.832Z","updated_at":"2016-06-17T07:47:33.832Z","due_date":null},"assignees":[{"name":"Jarret O'Keefe","username":"francisca","id":14,"state":"active","avatar_url":"http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon","web_url":"https://gitlab.example.com/francisca"}],"assignee":{"name":"Jarret O'Keefe","username":"francisca","id":14,"state":"active","avatar_url":"http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon","web_url":"https://gitlab.example.com/francisca"},"type":"ISSUE","author":{"name":"Maxie Medhurst","username":"craig_rutherford","id":12,"state":"active","avatar_url":"http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon","web_url":"https://gitlab.example.com/craig_rutherford"},"subscribed":true,"user_notes_count":7,"upvotes":0,"downvotes":0,"merge_requests_count":0,"due_date":null,"web_url":"http://gitlab.example.com/my-group/my-project/issues/10","references":{"short":"#10","relative":"#10","full":"my-group/my-project#10"},"confidential":false,"discussion_locked":false,"issue_type":"issue","severity":"UNKNOWN","task_completion_status":{"count":0,"completed_count":0}},"target_url":"https://gitlab.example.com/gitlab-org/gitlab-ci/issues/10","body":"Vel voluptas atque dicta mollitia adipisci qui at.","state":"pending","created_at":"2016-07-01T11:09:13.992Z"}
The assignee column is deprecated. We now show it as a single-sized array assignees to conform to the GitLab EE API.
Promote an issue to an epic
Promotes an issue to an epic by adding a comment with the /promotequick action.
To learn more about promoting issues to epics, visit Manage epics.
The content of a note. Must contain /promote at the start of a new line.
Example request:
curl --request POST --header"PRIVATE-TOKEN: <your_access_token>""https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=Lets%20promote%20this%20to%20an%20epic%0A%0A%2Fpromote"
Example response:
{"id":699,"type":null,"body":"Lets promote this to an epic","attachment":null,"author":{"id":1,"name":"Alexandra Bashirian","username":"eileen.lowe","state":"active","avatar_url":"https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"https://gitlab.example.com/eileen.lowe"},"created_at":"2020-12-03T12:27:17.844Z","updated_at":"2020-12-03T12:27:17.844Z","system":false,"noteable_id":461,"noteable_type":"Issue","resolvable":false,"confidential":false,"noteable_iid":33,"commands_changes":{"promote_to_epic":true}}
Set a time estimate for an issue
Sets an estimated time of work for this issue.
POST /projects/:id/issues/:issue_iid/time_estimate
If the project is private or the issue is confidential, you need to provide credentials to authorize.
The preferred way to do this, is by using personal access tokens.
Get all the merge requests that are related to the issue.
If the project is private or the issue is confidential, you need to provide credentials to authorize.
The preferred way to do this, is by using personal access tokens.
GET /projects/:id/issues/:issue_iid/related_merge_requests
[{"id":29,"iid":11,"project_id":1,"title":"Provident eius eos blanditiis consequatur neque odit.","description":"Ut consequatur ipsa aspernatur quisquam voluptatum fugit. Qui harum corporis quo fuga ut incidunt veritatis. Autem necessitatibus et harum occaecati nihil ea.\r\n\r\ntwitter/flight#8","state":"opened","created_at":"2018-09-18T14:36:15.510Z","updated_at":"2018-09-19T07:45:13.089Z","closed_by":null,"closed_at":null,"target_branch":"v2.x","source_branch":"so_long_jquery","user_notes_count":9,"upvotes":0,"downvotes":0,"author":{"id":14,"name":"Verna Hills","username":"lawanda_reinger","state":"active","avatar_url":"https://www.gravatar.com/avatar/de68a91aeab1cff563795fb98a0c2cc0?s=80&d=identicon","web_url":"https://gitlab.example.com/lawanda_reinger"},"assignee":{"id":19,"name":"Jody Baumbach","username":"felipa.kuvalis","state":"active","avatar_url":"https://www.gravatar.com/avatar/6541fc75fc4e87e203529bd275fafd07?s=80&d=identicon","web_url":"https://gitlab.example.com/felipa.kuvalis"},"source_project_id":1,"target_project_id":1,"labels":[],"draft":false,"work_in_progress":false,"milestone":{"id":27,"iid":2,"project_id":1,"title":"v1.0","description":"Et tenetur voluptatem minima doloribus vero dignissimos vitae.","state":"active","created_at":"2018-09-18T14:35:44.353Z","updated_at":"2018-09-18T14:35:44.353Z","due_date":null,"start_date":null,"web_url":"https://gitlab.example.com/twitter/flight/milestones/2"},"merge_when_pipeline_succeeds":false,"merge_status":"cannot_be_merged","sha":"3b7b528e9353295c1c125dad281ac5b5deae5f12","merge_commit_sha":null,"squash_commit_sha":null,"discussion_locked":null,"should_remove_source_branch":null,"force_remove_source_branch":false,"reference":"!11","web_url":"https://gitlab.example.com/twitter/flight/merge_requests/4","references":{"short":"!4","relative":"!4","full":"twitter/flight!4"},"time_stats":{"time_estimate":0,"total_time_spent":0,"human_time_estimate":null,"human_total_time_spent":null},"squash":false,"task_completion_status":{"count":0,"completed_count":0},"changes_count":"10","latest_build_started_at":"2018-12-05T01:16:41.723Z","latest_build_finished_at":"2018-12-05T02:35:54.046Z","first_deployed_to_production_at":null,"pipeline":{"id":38980952,"sha":"81c6a84c7aebd45a1ac2c654aa87f11e32338e0a","ref":"test-branch","status":"success","web_url":"https://gitlab.com/gitlab-org/gitlab/pipelines/38980952"},"head_pipeline":{"id":38980952,"sha":"81c6a84c7aebd45a1ac2c654aa87f11e32338e0a","ref":"test-branch","status":"success","web_url":"https://gitlab.example.com/twitter/flight/pipelines/38980952","before_sha":"3c738a37eb23cf4c0ed0d45d6ddde8aad4a8da51","tag":false,"yaml_errors":null,"user":{"id":19,"name":"Jody Baumbach","username":"felipa.kuvalis","state":"active","avatar_url":"https://www.gravatar.com/avatar/6541fc75fc4e87e203529bd275fafd07?s=80&d=identicon","web_url":"https://gitlab.example.com/felipa.kuvalis"},"created_at":"2018-12-05T01:16:13.342Z","updated_at":"2018-12-05T02:35:54.086Z","started_at":"2018-12-05T01:16:41.723Z","finished_at":"2018-12-05T02:35:54.046Z","committed_at":null,"duration":4436,"coverage":"46.68","detailed_status":{"icon":"status_warning","text":"passed","label":"passed with warnings","group":"success-with-warnings","tooltip":"passed","has_details":true,"details_path":"/twitter/flight/pipelines/38","illustration":null,"favicon":"https://gitlab.example.com/assets/ci_favicons/favicon_status_success-8451333011eee8ce9f2ab25dc487fe24a8758c694827a582f17f42b0a90446a2.png"}},"diff_refs":{"base_sha":"d052d768f0126e8cddf80afd8b1eb07f406a3fcb","head_sha":"81c6a84c7aebd45a1ac2c654aa87f11e32338e0a","start_sha":"d052d768f0126e8cddf80afd8b1eb07f406a3fcb"},"merge_error":null,"user":{"can_merge":true}}]
List merge requests that close a particular issue on merge
Get all merge requests that close a particular issue when merged.
If the project is private or the issue is confidential, you need to provide credentials to authorize.
The preferred way to do this, is by using personal access tokens.
[{"id":6471,"iid":6432,"project_id":1,"title":"add a test for cgi lexer options","description":"closes #11","state":"opened","created_at":"2017-04-06T18:33:34.168Z","updated_at":"2017-04-09T20:10:24.983Z","target_branch":"master","source_branch":"feature.custom-highlighting","upvotes":0,"downvotes":0,"author":{"name":"Administrator","username":"root","id":1,"state":"active","avatar_url":"http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon","web_url":"https://gitlab.example.com/root"},"assignee":null,"source_project_id":1,"target_project_id":1,"closed_at":null,"closed_by":null,"labels":[],"draft":false,"work_in_progress":false,"milestone":null,"merge_when_pipeline_succeeds":false,"merge_status":"unchecked","sha":"5a62481d563af92b8e32d735f2fa63b94e806835","merge_commit_sha":null,"squash_commit_sha":null,"user_notes_count":1,"should_remove_source_branch":null,"force_remove_source_branch":false,"web_url":"https://gitlab.example.com/gitlab-org/gitlab-test/merge_requests/6432","reference":"!6432","references":{"short":"!6432","relative":"!6432","full":"gitlab-org/gitlab-test!6432"},"time_stats":{"time_estimate":0,"total_time_spent":0,"human_time_estimate":null,"human_total_time_spent":null}}]
Participants on issues
If the project is private or the issue is confidential, you need to provide credentials to authorize.
The preferred way to do this, is by using personal access tokens.