Sample - GitHub REST API
GET/repos/{owner}/{repo}/issues/{issue_number}/timeline

List timeline events for an issue

Lists timeline events for a specific issue in a repository. Use exclude to omit selected event types, and use page and per_page to paginate the results; per_page can be at most 100.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 parameters
ownerstringrequired
The account owner of the repository; the name is not case sensitive.
repostringrequired
The repository name without the `.git` extension; the name is not case sensitive.
issue_numberintegerrequired
The number identifying the issue.
per_pageintegeroptional
The number of timeline events to return per page. Defaults to 30 when omitted and must not exceed 100.
Default:30
pageintegeroptional
The page number to retrieve. Defaults to 1 when omitted.
Default:1
excludestringoptional
A comma-separated list of timeline event names to exclude from the response.

4 status codes
200Returns an array of timeline event objects for the issue, including event-specific properties such as the actor, event type, timestamps, labels, or milestones.
idintegerrequired
node_idstringrequired
urlstringrequired
actorobjectrequired
A GitHub user.
eventstringrequired
commit_idstringrequired
commit_urlstringrequired
created_atstringrequired
performed_via_github_appobjectrequired
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
labelobjectrequired
intentobjectoptional
The intent behind an agent's action on an issue, including the rationale and confidence. Present (and `null` when the event carried no agent intent) on supported event types while the issue suggestions feature is enabled for the repository; the property is omitted entirely when the feature is disabled or the event type does not support intent.
400Returned when the request is invalid.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Returned when the repository or issue cannot be found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
410Returned when the requested resource is no longer available.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 400 is returned when the request parameters are invalid. A 404 is returned when the repository or issue cannot be found, and a 410 is returned when the endpoint is no longer available. per_page must not exceed 100.