Skip to content

List all project issues

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

Lists all issues for a specified project. If the project is private, you need to provide credentials to authorize. In most cases, you should authenticate with a personal access token.

id
required
One of:
string

The ID or URL-encoded path of the project

with_labels_details
boolean
nullable

Return titles of labels and other details

state
string
default: all nullable
Allowed values: opened closed all

Return opened, closed, or all issues

closed_by_id
integer
nullable

Return issues which were closed by the user with the given ID.

order_by
string
default: created_at nullable
Allowed values: created_at due_date label_priority milestone_due popularity priority relative_position title updated_at weight

Return issues ordered by created_at, due_date, label_priority, milestone_due, popularity, priority, relative_position, title, or updated_at fields.

sort
string
default: desc nullable
Allowed values: asc desc

Return issues sorted in asc or desc order.

due_date
string
nullable
Allowed values: 0 any today tomorrow overdue week month next_month_and_previous_two_weeks ""

Return issues that have no due date (0), or whose due date is this week, this month, between two weeks ago and next month, or which are overdue. Accepts: overdue, week, month, next_month_and_previous_two_weeks, 0

issue_type
string
nullable
Allowed values: issue incident test_case requirement task ticket

The type of the issue. Accepts: issue, incident, test_case, requirement, task, ticket

labels
Array<string>
nullable

Comma-separated list of label names

milestone
string
nullable

Milestone title

milestone_id
string
nullable
Allowed values: Any None Upcoming Started

Return issues assigned to milestones with the specified timebox value (“Any”, “None”, “Upcoming” or “Started”)

iids
Array<integer>
nullable

The IID array of issues

search
string
nullable

Search issues for text present in the title, description, or any combination of these

in
string
nullable

title, description, or a string joining them with comma

author_id
integer
nullable

Return issues which are authored by the user with the given ID

author_username
string
nullable

Return issues which are authored by the user with the given username

assignee_id
One of:
integer
nullable

Return issues which are assigned to the user with the given ID

assignee_username
Array<string>
nullable

Return issues which are assigned to the user with the given username

created_after
string format: date-time
nullable

Return issues created after the specified time

created_before
string format: date-time
nullable

Return issues created before the specified time

updated_after
string format: date-time
nullable

Return issues updated after the specified time

updated_before
string format: date-time
nullable

Return issues updated before the specified time

not

Filters by the specified parameters

object
not[labels]
Array<string>
nullable

Comma-separated list of label names

not[milestone]
string
nullable

Milestone title

not[milestone_id]
string
nullable
Allowed values: Any None Upcoming Started

Return issues assigned to milestones without the specified timebox value (“Any”, “None”, “Upcoming” or “Started”)

not[iids]
Array<integer>
nullable

The IID array of issues

not[author_id]
integer
nullable

Return issues which are not authored by the user with the given ID

not[author_username]
string
nullable

Return issues which are not authored by the user with the given username

not[assignee_id]
integer
nullable

Return issues which are not assigned to the user with the given ID

not[assignee_username]
Array<string>
nullable

Return issues which are not assigned to the user with the given username

not[weight]
integer
nullable

Return issues without the specified weight

not[iteration_id]
One of:
integer
nullable

Return issues which are not assigned to the iteration with the given ID

not[iteration_title]
string
nullable

Return issues which are not assigned to the iteration with the given title

scope
string
nullable
Allowed values: created-by-me assigned-to-me created_by_me assigned_to_me all

Return issues for the given scope: created_by_me, assigned_to_me or all

my_reaction_emoji
string
nullable

Return issues reacted by the authenticated user by the given emoji

confidential
boolean
nullable

Filter confidential or public issues

weight
One of:
integer
nullable

The weight of the issue

epic_id
One of:
integer
nullable

The ID of an epic associated with the issues

health_status
string
nullable
Allowed values: on_track needs_attention at_risk none any

The health status of the issue. Must be one of: on_track, needs_attention, at_risk, none, any

iteration_id
One of:
integer
nullable

Return issues which are assigned to the iteration with the given ID

iteration_title
string
nullable

Return issues which are assigned to the iteration with the given title

page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20
cursor
string
nullable

Cursor for obtaining the next set of records

OK

Media type application/json
object
id
integer format: int64
iid
integer
project_id
integer format: int64
title
string
description
string
state
string
created_at
string format: date-time
updated_at
string format: date-time
closed_at
string format: date-time
closed_by
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
labels
Array<string>
milestone
object
id
integer format: int64
iid
integer format: int64
project_id
integer format: int64
group_id
string
title
string
description
string
state
string
created_at
string
updated_at
string
due_date
string
start_date
string
expired
boolean
web_url
string
assignees
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
author
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
type

One of [“ISSUE”, “INCIDENT”, “TEST_CASE”, “REQUIREMENT”, “TASK”, “TICKET”]

string
assignee
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
user_notes_count
integer
merge_requests_count
integer
upvotes
integer
downvotes
integer
start_date
string format: date
due_date
string format: date
confidential
boolean
discussion_locked
boolean
issue_type
string
web_url
string
time_stats
object
time_estimate
integer
total_time_spent
integer
human_time_estimate
string
human_total_time_spent
string
task_completion_status
object
count
integer
completed_count
integer
weight
integer
blocking_issues_count
integer
has_tasks
boolean
task_status
string
_links
object
references
object
short
string
relative
string
full
string
severity

One of [“UNKNOWN”, “LOW”, “MEDIUM”, “HIGH”, “CRITICAL”]

string
subscribed
boolean
moved_to_id
integer format: int64
imported
boolean
imported_from
string
service_desk_reply_to
string
epic_iid
string
epic
object
id
string
iid
string
title
string
url
string
group_id
string
human_readable_end_date
string
human_readable_timestamp
string
iteration
object
id
integer format: int64
iid
integer
sequence
integer
group_id
integer format: int64
title
string
description
string
state
integer
created_at
string format: date-time
updated_at
string format: date-time
start_date
string format: date
due_date
string format: date
web_url
string
health_status
string
Example
{
"id": 84,
"iid": 14,
"project_id": 4,
"title": "Impedit et ut et dolores vero provident ullam est",
"description": "Repellendus impedit et vel velit dignissimos.",
"state": "closed",
"created_at": "2022-08-17T12:46:35.053Z",
"updated_at": "2022-11-14T17:22:01.470Z",
"closed_at": "2022-11-15T08:30:55.232Z",
"closed_by": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"labels": [
"bug"
],
"assignees": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"author": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"type": "ISSUE",
"assignee": {
"id": 1,
"username": "admin",
"public_email": "john@example.com",
"name": "Administrator",
"state": "active",
"avatar_url": "https://gravatar.com/avatar/1",
"avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
"custom_attributes": [
{
"key": "foo",
"value": "bar"
}
],
"web_url": "https://gitlab.example.com/root"
},
"start_date": "2022-11-18",
"due_date": "2022-11-20",
"issue_type": "issue",
"web_url": "http://example.com/example/example/issues/14",
"time_stats": {
"time_estimate": 12600,
"total_time_spent": 3600,
"human_time_estimate": "3h 30m",
"human_total_time_spent": "1h"
},
"task_completion_status": {
"count": 5,
"completed_count": 3
},
"weight": 5,
"blocking_issues_count": 2,
"has_tasks": true,
"task_status": "2 of 4 tasks completed",
"references": {
"short": "&6",
"relative": "&6",
"full": "test&6"
},
"subscribed": false,
"moved_to_id": 1,
"imported": false,
"imported_from": "github",
"service_desk_reply_to": "user@example.com",
"iteration": {
"id": 1,
"iid": 1,
"sequence": 1,
"group_id": 1,
"title": "Iteration I",
"description": "Iteration description",
"state": 1,
"created_at": "2022-01-31T15:10:45.080Z",
"updated_at": "2022-01-31T15:10:45.080Z",
"start_date": "2022-01-01",
"due_date": "2022-01-31",
"web_url": "https://gitlab.example.com/groups/gitlab-org/-/iterations/1"
}
}

Bad Request

Not Found