v5

latestSwagger 2.0MIT2026-08-03485217850.7 KB

issue

List all comments and events on an issue

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

Path parameters

ownerstring required

owner of the repo

repostring required

name of the repo

indexinteger required

index of the issue

Query parameters

sincestring date-time

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

pageinteger

page number of results to return (1-based)

limitinteger

page size of results

beforestring date-time

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

Response

TimelineList

bodystring

Body contains the timeline event content

created_atstring date-time

html_urlstring

HTMLURL is the web URL for viewing the comment

idinteger

ID is the unique identifier for the timeline comment

issue_urlstring

IssueURL is the API URL for the issue

new_refstring

new_titlestring

old_project_idinteger

old_refstring

old_titlestring

project_idinteger

pull_request_urlstring

PRURL is the API URL for the pull request (if applicable)

ref_actionstring

ref_commit_shastring

commit SHA where issue/PR was referenced

removed_assigneeboolean

whether the assignees were removed or added

review_idinteger

typestring

Type indicates the type of timeline event

updated_atstring date-time

Example response

[
  {
    "assignee_team": {
      "units": [
        "repo.code",
        "repo.issues",
        "repo.ext_issues",
        "repo.wiki",
        "repo.pulls",
        "repo.releases",
        "repo.projects",
        "repo.ext_wiki"
      ],
      "units_map": {
        "repo.code": "read",
        "repo.ext_issues": "none",
        "repo.ext_wiki": "none",
        "repo.issues": "write",
        "repo.projects": "none",
        "repo.pulls": "owner",
        "repo.releases": "none",
        "repo.wiki": "admin"
      }
    },
    "dependent_issue": {
      "labels": [
        {
          "color": "00aabb"
        }
      ]
    },
    "label": {
      "color": "00aabb"
    },
    "ref_issue": {
      "labels": [
        {
          "color": "00aabb"
        }
      ]
    },
    "tracked_time": {
      "issue": {
        "labels": [
          {
            "color": "00aabb"
          }
        ]
      }
    }
  }
]