Skip to content
forgit api docs

List all comments and events on an issue

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

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

index
required
integer format: int64

Index of the issue

Query Parameters

Section titled “ Query Parameters ”
since
string format: date-time

If provided, only comments updated since the specified time are returned.

page
integer

Page number of results to return (1-based)

limit
integer

Page size of results

before
string format: date-time

If provided, only comments updated before the provided time are returned.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

TimelineList

Media type application/json
Array<object>

TimelineComment represents a timeline comment (comment of any type) on a commit or issue

object
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
assignee_team

Team represents a team in an organization

object
can_create_org_repo
boolean
description
string
id
integer format: int64
includes_all_repositories
boolean
name
string
organization

Organization represents an organization

object
avatar_url
string
created
string format: date-time
description
string
email
string
full_name
string
id
integer format: int64
location
string
name
string
repo_admin_change_team_access
boolean
username

Deprecated

string
visibility
string
website
string
permission
string
Allowed values: none read write admin owner
units
Array<string>
units_map
object
key
additional properties
string
body
string
created_at
string format: date-time
dependent_issue

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
html_url
string
id
integer format: int64
issue_url
string
label

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
new_ref
string
new_title
string
old_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
old_project_id
integer format: int64
old_ref
string
old_title
string
project_id
integer format: int64
pull_request_url
string
ref_action
string
ref_comment

Comment represents a comment on a commit or issue

object
assets

The attachments to the comment

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
body

The body of the comment

string
created_at

The time of the comment’s creation

string format: date-time
html_url

The HTML URL of the comment

string
id

The identifier of the comment

integer format: int64
issue_url

The HTML URL of the issue if the comment is posted on an issue, else empty string

string
original_author

The original author that posted the comment if it was not posted locally, else empty string

string
original_author_id

The ID of the original author that posted the comment if it was not posted locally, else 0

integer format: int64
pull_request_url

The HTML URL of the pull request if the comment is posted on a pull request, else empty string

string
updated_at

The time of the comment’s update

string format: date-time
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
ref_commit_sha

Commit SHA where issue/PR was referenced

string
ref_issue

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
removed_assignee

Whether the assignees were removed or added

boolean
resolve_doer

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
review_id
integer format: int64
tracked_time

TrackedTime worked time for an issue / pr

object
created
string format: date-time
id
integer format: int64
issue

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
issue_id

Deprecated (only for backwards compatibility)

integer format: int64
time

Time in seconds

integer format: int64
user_id

Deprecated (only for backwards compatibility)

integer format: int64
user_name
string
type
string
updated_at
string format: date-time
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 
[
  {
    "assignee": {
      "login_name": "empty"
    },
    "assignee_team": {
      "permission": "none",
      "units": [
        "repo.code",
        "repo.issues",
        "repo.ext_issues",
        "repo.wiki",
        "repo.pulls",
        "repo.releases",
        "repo.projects",
        "repo.ext_wiki"
      ],
      "units_map": {
        "repo.actions": "none",
        "repo.code": "read",
        "repo.ext_issues": "none",
        "repo.ext_wiki": "none",
        "repo.issues": "write",
        "repo.packages": "none",
        "repo.projects": "none",
        "repo.pulls": "owner",
        "repo.releases": "none",
        "repo.wiki": "admin"
      }
    },
    "dependent_issue": {
      "assets": [
        {
          "type": "attachment"
        }
      ],
      "assignee": {
        "login_name": "empty"
      },
      "assignees": [
        {
          "login_name": "empty"
        }
      ],
      "labels": [
        {
          "color": "00aabb",
          "exclusive": false,
          "is_archived": false
        }
      ],
      "user": {
        "login_name": "empty"
      }
    },
    "label": {
      "color": "00aabb",
      "exclusive": false,
      "is_archived": false
    },
    "ref_comment": {
      "assets": [
        {
          "type": "attachment"
        }
      ],
      "user": {
        "login_name": "empty"
      }
    },
    "ref_issue": {
      "assets": [
        {
          "type": "attachment"
        }
      ],
      "assignee": {
        "login_name": "empty"
      },
      "assignees": [
        {
          "login_name": "empty"
        }
      ],
      "labels": [
        {
          "color": "00aabb",
          "exclusive": false,
          "is_archived": false
        }
      ],
      "user": {
        "login_name": "empty"
      }
    },
    "resolve_doer": {
      "login_name": "empty"
    },
    "tracked_time": {
      "issue": {
        "assets": [
          {
            "type": "attachment"
          }
        ],
        "assignee": {
          "login_name": "empty"
        },
        "assignees": [
          {
            "login_name": "empty"
          }
        ],
        "labels": [
          {
            "color": "00aabb",
            "exclusive": false,
            "is_archived": false
          }
        ],
        "user": {
          "login_name": "empty"
        }
      }
    },
    "user": {
      "login_name": "empty"
    }
  }
]

Headers

Section titled “ Headers ”
X-Total-Count
integer format: int64

The total number of timeline comments

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"
}

500

Section titled “ 500 ”

APIInternalServerError is an error that is raised when an internal server error occurs

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