issues

List timeline events for an issue

List all timeline events for an issue.

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

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

issue_numberinteger required

The number that identifies the issue.

Query parameters

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

excludestring

A comma-separated list of timeline event names to exclude from the response.

Response

Example response

[
  {
    "actor": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "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",
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "user_view_type": "public"
    },
    "performed_via_github_app": {
      "id": 37,
      "slug": "probot-owners",
      "node_id": "MDExOkludGVncmF0aW9uMQ==",
      "client_id": "\"Iv1.25b5d1e65ffc4022\"",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
        "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",
        "starred_at": "\"2020-07-09T00:17:55Z\"",
        "user_view_type": "public"
      },
      "name": "Probot Owners",
      "description": "The description of the app.",
      "external_url": "https://example.com",
      "html_url": "https://github.com/apps/super-ci",
      "created_at": "2017-07-08T16:18:44-04:00",
      "updated_at": "2017-07-08T16:18:44-04:00",
      "permissions": {
        "issues": "read",
        "deployments": "write"
      },
      "events": [
        "label",
        "deployment"
      ],
      "installations_count": 5
    }
  }
]

Changes

Changed in 9 of the 62 revisions of this API.220

Aug 26, 20262022-11-282a292eb46bb41See the full diff
- ○
  added timeline-connected-event timeline-disconnected-event to the items/ response property anyOf list for the response status 200
  response-property-any-of-added
Jul 22, 20262022-11-28b6e268937c081See the full diff
- ○
  added the new optional query request parameter exclude
  new-optional-request-parameter
Jul 21, 20262022-11-285286c35535537See the full diff
- ○
  added the optional property items/anyOf[subschema #1: Labeled Issue Event]/intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #20: Timeline Assigned Issue Event]/intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #22: State Change Issue Event]/intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #23: Issue Type Added Issue Event]/intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #24: Issue Type Removed Issue Event]/intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #25: Issue Type Changed Issue Event]/intent to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #2: Unlabeled Issue Event]/intent to the response with the 200 status
  response-optional-property-added
Jun 29, 20262022-11-282da668dda9282See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added blocked-by-added-issue-event blocked-by-removed-issue-event blocking-added-issue-event blocking-removed-issue-event to the items/ response property anyOf list for the response status 200
  response-property-any-of-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 25, 20262022-11-2899fbf691354b1See the full diff
- ○
  added sub-issue-added-issue-event sub-issue-removed-issue-event parent-issue-added-issue-event parent-issue-removed-issue-event to the items/ response property anyOf list for the response status 200
  response-property-any-of-added
Jun 23, 20262022-11-28fd784b1d2c896See the full diff
- ○
  added the optional property items/anyOf[subschema #14: Timeline Comment Event]/minimized to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #15: Timeline Cross Referenced Event]/source/issue/issue_field_values/items/issue_field_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #15: Timeline Cross Referenced Event]/source/issue/pinned_comment/minimized to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #6: Review Requested Issue Event]/requested_team/access_source to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/anyOf[subschema #7: Review Request Removed Issue Event]/requested_team/access_source to the response with the 200 status
  response-optional-property-added
- ○
  added issue-type-added-issue-event issue-type-removed-issue-event issue-type-changed-issue-event to the items/ response property anyOf list for the response status 200
  response-property-any-of-added
Jun 8, 20262022-11-28cb5598bcb83211See the full diff
- ●
  added the new multi_select enum value to the items/anyOf[subschema #15: Timeline Cross Referenced Event]/source/issue/issue_field_values/items/data_type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property items/anyOf[subschema #15: Timeline Cross Referenced Event]/source/issue/issue_field_values/items/multi_select_options to the response with the 200 status
  response-optional-property-added
Mar 19, 20262022-11-289120d883b76e1See the full diff
- ●
  removed the optional property items/anyOf[subschema #15: Timeline Cross Referenced Event]/source/issue/repository/has_commit_comments from the response with the 200 status
  response-optional-property-removed
Mar 11, 20262022-11-28434db317b4c11See the full diff
- ○
  added the optional property items/anyOf[subschema #15: Timeline Cross Referenced Event]/source/issue/repository/has_commit_comments to the response with the 200 status
  response-optional-property-added

Of the 62 revisions, 1 has no diff computed.

Full history