This version of GitHub Enterprise was discontinued on 2023-07-06. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.
After a site administrator upgrades your Enterprise Server instance to Enterprise Server 3.9 or later, the REST API will be versioned. To learn how to find your instance's version, see "About versions of GitHub Docs". For more information, see "About API versioning."
Timeline events
Use the REST API to receive events triggered by timeline activity in issues and pull requests.
About timeline events
You can use the REST API to view different types of events triggered by timeline activity in issues and pull requests. For more information about the specific events that you can receive, see "Issue event types." To view GitHub activity outside of issues and pull requests, see "GitHub event types."
You can use timeline events to display information about issues and pull requests or determine who should be notified of issue comments.
Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like managing assignees, labels, and milestones, are provided within the Issues endpoints.
List timeline events for an issue
Works with GitHub Apps
List all timeline events for an issue.
Parameters for "List timeline events for an issue"
| Headers |
|---|
| Name, Type, Description |
accept string Setting to |
| Path parameters |
| Name, Type, Description |
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
issue_number integer RequiredThe number that identifies the issue. |
| Query parameters |
| Name, Type, Description |
per_page integer The number of results per page (max 100). Default: |
page integer Page number of the results to fetch. Default: |
HTTP response status codes for "List timeline events for an issue"
| Status code | Description |
|---|---|
200 | OK |
404 | Resource not found |
410 | Gone |
Code samples for "List timeline events for an issue"
get/repos/{owner}/{repo}/issues/{issue_number}/timeline
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/issues/ISSUE_NUMBER/timelineResponse
Status: 200[
{
"id": 6430295168,
"node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA",
"url": "https://HOSTNAME/repos/github/roadmap/issues/events/6430295168",
"actor": {
"login": "github",
"id": 9919,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
"gravatar_id": "",
"url": "https://HOSTNAME/users/github",
"html_url": "https://github.com/github",
"followers_url": "https://HOSTNAME/users/github/followers",
"following_url": "https://HOSTNAME/users/github/following{/other_user}",
"gists_url": "https://HOSTNAME/users/github/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/github/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/github/subscriptions",
"organizations_url": "https://HOSTNAME/users/github/orgs",
"repos_url": "https://HOSTNAME/users/github/repos",
"events_url": "https://HOSTNAME/users/github/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/github/received_events",
"type": "Organization",
"site_admin": false
},
"event": "locked",
"commit_id": null,
"commit_url": null,
"created_at": "2022-04-13T20:49:13Z",
"lock_reason": null,
"performed_via_github_app": null
},
{
"id": 6430296748,
"node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs",
"url": "https://HOSTNAME/repos/github/roadmap/issues/events/6430296748",
"actor": {
"login": "github-product-roadmap",
"id": 67656570,
"node_id": "MDQ6VXNlcjY3NjU2NTcw",
"avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
"gravatar_id": "",
"url": "https://HOSTNAME/users/github-product-roadmap",
"html_url": "https://github.com/github-product-roadmap",
"followers_url": "https://HOSTNAME/users/github-product-roadmap/followers",
"following_url": "https://HOSTNAME/users/github-product-roadmap/following{/other_user}",
"gists_url": "https://HOSTNAME/users/github-product-roadmap/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/github-product-roadmap/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/github-product-roadmap/subscriptions",
"organizations_url": "https://HOSTNAME/users/github-product-roadmap/orgs",
"repos_url": "https://HOSTNAME/users/github-product-roadmap/repos",
"events_url": "https://HOSTNAME/users/github-product-roadmap/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/github-product-roadmap/received_events",
"type": "User",
"site_admin": false
},
"event": "labeled",
"commit_id": null,
"commit_url": null,
"created_at": "2022-04-13T20:49:34Z",
"label": {
"name": "beta",
"color": "99dd88"
},
"performed_via_github_app": null
},
{
"id": 6635165802,
"node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq",
"url": "https://HOSTNAME/repos/github/roadmap/issues/events/6635165802",
"actor": {
"login": "github-product-roadmap",
"id": 67656570,
"node_id": "MDQ6VXNlcjY3NjU2NTcw",
"avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4",
"gravatar_id": "",
"url": "https://HOSTNAME/users/github-product-roadmap",
"html_url": "https://github.com/github-product-roadmap",
"followers_url": "https://HOSTNAME/users/github-product-roadmap/followers",
"following_url": "https://HOSTNAME/users/github-product-roadmap/following{/other_user}",
"gists_url": "https://HOSTNAME/users/github-product-roadmap/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/github-product-roadmap/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/github-product-roadmap/subscriptions",
"organizations_url": "https://HOSTNAME/users/github-product-roadmap/orgs",
"repos_url": "https://HOSTNAME/users/github-product-roadmap/repos",
"events_url": "https://HOSTNAME/users/github-product-roadmap/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/github-product-roadmap/received_events",
"type": "User",
"site_admin": false
},
"event": "renamed",
"commit_id": null,
"commit_url": null,
"created_at": "2022-05-18T19:29:01Z",
"rename": {
"from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)",
"to": "Secret scanning: dry-runs for enterprise-level custom patterns"
},
"performed_via_github_app": null
},
{
"url": "https://HOSTNAME/repos/github/roadmap/issues/comments/1130876857",
"html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857",
"issue_url": "https://HOSTNAME/repos/github/roadmap/issues/493",
"id": 1130876857,
"node_id": "IC_kwDODwFebM5DZ8-5",
"user": {
"login": "octocat",
"id": 94867353,
"node_id": "U_kgDOBaePmQ",
"avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": true
},
"created_at": "2022-05-19T00:52:15Z",
"updated_at": "2022-05-19T00:52:15Z",
"author_association": "COLLABORATOR",
"body": "🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/",
"reactions": {
"url": "https://HOSTNAME/repos/github/roadmap/issues/comments/1130876857/reactions",
"total_count": 0,
"+1": 0,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
},
"performed_via_github_app": null,
"event": "commented",
"actor": {
"login": "octocat",
"id": 94867353,
"node_id": "U_kgDOBaePmQ",
"avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4",
"gravatar_id": "",
"url": "https://HOSTNAME/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://HOSTNAME/users/octocat/followers",
"following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
"gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
"starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
"organizations_url": "https://HOSTNAME/users/octocat/orgs",
"repos_url": "https://HOSTNAME/users/octocat/repos",
"events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
"received_events_url": "https://HOSTNAME/users/octocat/received_events",
"type": "User",
"site_admin": true
}
}
]