Skip to content
forgit api docs

List a repository's issues

GET
/repos/{owner}/{repo}/issues

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

Query Parameters

Section titled “ Query Parameters ”
state
string
Allowed values: closed open all

Whether issue is open or closed

labels
string

Comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded

q
string

Search string

type
string
Allowed values: issues pulls

Filter by type (issues / pulls) if set

milestones
string

Comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded

since
string format: date-time

Only show items updated after the given time. This is a timestamp in RFC 3339 format

before
string format: date-time

Only show items updated before the given time. This is a timestamp in RFC 3339 format

created_by
string

Only show items which were created by the given user

assigned_by
string

Only show items for which the given user is assigned

mentioned_by
string

Only show items in which the given user was mentioned

page
integer

Page number of results to return (1-based)

limit
integer

Page size of results

sort
string
default: latest
Allowed values: relevance latest oldest recentupdate leastupdate mostcomment leastcomment nearduedate farduedate

Type of sort

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

IssueList

Media type application/json
Array<object>

Issue represents an issue in a repository

object
assets
Array<object>

Attachment a generic attachment

object
browser_download_url
string
created_at
string format: date-time
download_count
integer format: int64
id
integer format: int64
name
string
size
integer format: int64
type
string
Allowed values: attachment external
uuid
string
assignee

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
assignees
Array<object>

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
body
string
closed_at
string format: date-time
comments
integer format: int64
created_at
string format: date-time
due_date
string format: date-time
html_url
string
id
integer format: int64
is_locked
boolean
labels
Array<object>

Label a label to an issue or a pr

object
color
string
description
string
exclusive
boolean
id
integer format: int64
is_archived
boolean
name
string
url
string
milestone

Milestone milestone is a collection of issues on one repository

object
closed_at
string format: date-time
closed_issues
integer format: int64
created_at
string format: date-time
description
string
due_on
string format: date-time
id
integer format: int64
open_issues
integer format: int64
state

StateType issue state type

string
title
string
updated_at
string format: date-time
number
integer format: int64
original_author
string
original_author_id
integer format: int64
pin_order
integer format: int64
pull_request

PullRequestMeta PR info if an issue is a PR

object
draft
boolean
html_url
string
merged
boolean
merged_at
string format: date-time
ref
string
repository

RepositoryMeta basic repository information

object
full_name
string
id
integer format: int64
name
string
owner
string
state

StateType issue state type

string
title
string
updated_at
string format: date-time
url
string
user

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
Example 
[
  {
    "assets": [
      {
        "type": "attachment"
      }
    ],
    "assignee": {
      "login_name": "empty"
    },
    "assignees": [
      {
        "login_name": "empty"
      }
    ],
    "labels": [
      {
        "color": "00aabb",
        "exclusive": false,
        "is_archived": false
      }
    ],
    "user": {
      "login_name": "empty"
    }
  }
]

404

Section titled “ 404 ”

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

422

Section titled “ 422 ”

APIValidationError is error format response related to input validation

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}