Note: The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details. To access the API you must provide a custom media type in the Accept header:

application/vnd.github.mockingbird-preview

Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support.

Timeline

Records various events that occur around an issue or pull request. This is useful both for display on issue and pull request information pages, as well as to determine who should be notified of comments.

Events

Name Description
added_to_project The issue was added to a project board.You only see this event in responses when project boards have been enabled in the repository.
assigned The issue was assigned to the assignee.
closed The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using "closes / fixes #NN" syntax.
commented A comment was added to the issue.
committed A commit was added to the pull request's HEAD branch. Only provided for pull requests.
converted_note_to_issue The issue was created by converting a note in a project board to an issue. You only see this event in responses when project boards have been enabled in the repository.
cross-referenced The issue was referenced from another issue. The source attribute contains the id, actor, and url of the reference's source.
demilestoned The issue was removed from a milestone.
head_ref_deleted The pull request's branch was deleted.
head_ref_restored The pull request's branch was restored.
labeled A label was added to the issue.
locked The issue was locked by the actor.
marked_as_duplicate A user with write permissions marked an issue as a duplicate of another issue or a pull request as a duplicate of another pull request.
mentioned The actor was @mentioned in an issue body.
merged The issue was merged by the actor. The commit_id attribute is the SHA1 of the HEAD commit that was merged.
milestoned The issue was added to a milestone.
moved_columns_in_project The issue was moved between columns in a project board. You only see this event in responses when project boards have been enabled in the repository.
referenced The issue was referenced from a commit message. The commit_id attribute is the commit SHA1 of where that happened.
removed_from_project The issue was removed from a project board. You only see this event in responses when project boards have been enabled in the repository.
renamed The issue title was changed.
reopened The issue was reopened by the actor.
review_dismissed The actor dismissed a review from the pull request.
review_requested The actor requested a review from the subject on this pull request.
review_request_removed The actor removed the review request for the subject on this pull request.
subscribed The actor subscribed to receive notifications for an issue.
unassigned The assignee was unassigned from the issue.
unlabeled A label was removed from the issue.
unlocked The issue was unlocked by the actor.
unmarked_as_duplicate An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.
unsubscribed The actor unsubscribed to stop receiving notifications for an issue.
user_blocked An organization owner blocked a user from the organization. This was done through one of the blocked user's comments on the issue.

Attributes

Name Description
id The Integer ID of the event.
node_id The Global Node ID of the event.
url The API URL for fetching the event.
actor The User object that generated the event.
commit_id The String SHA of a commit that referenced this Issue.
event Identifies the actual type of Event that occurred.
created_at The timestamp indicating when the event occurred.
label The Label object including name and color attributes. Only provided for labeled and unlabeled events.
assignee The User object which was assigned to (or unassigned from) this Issue. Only provided for assigned and unassigned events.
dismissed_review A dismissed_review object that includes the state, review_id, dismissal_message, and dismissal_commit_id (the ID of the commit that dismissed the review) if one exists. Possible state strings include commented, approved, or changes_requested. Only provided for review_dismissed events.
milestone The Milestone object including a title attribute. Only provided for milestoned and demilestoned events.
project_card A project_card object that includes the id, url, project_id, project_url, column_name, and previous_column_name (The name of the column that the card was listed in prior to column_name. Only returned for moved_columns_in_project events).
Note: The project_card object is part of the starfox-preview, and will only be included when you pass the custom media type.
source The id, actor, and url for the source of a reference from another issue. Only provided for cross-referenced events.
rename An object containing rename details including from and to attributes. Only provided for renamed events.

List events for an issue

Note: The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details. To access the API you must provide a custom media type in the Accept header:

application/vnd.github.mockingbird-preview

Note: Project card details are now shown in REST API v3 responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the blog post.

To receive the project_card attribute, project boards must be enabled for a repository, and you must provide a custom media type in the Accept header:

application/vnd.github.starfox-preview+json

Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support.

GET /repos/:owner/:repo/issues/:issue_number/timeline

Response

Status: 200 OK
Link: <https://api.github.com/resource?page=2>; rel="next",
      <https://api.github.com/resource?page=5>; rel="last"
[
  {
    "id": 1,
    "node_id": "MDEwOklzc3VlRXZlbnQx",
    "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1",
    "actor": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "event": "closed",
    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "created_at": "2011-04-14T16:00:49Z"
  }
]