List events received by the authenticated user
These are events that you’ve received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.
[!NOTE] This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ”The handle for the GitHub user account.
Query Parameters
Section titled “ Query Parameters ”The number of results per page (max 100). For more information, see “Using pagination in the REST API.”
The page number of the results to fetch. For more information, see “Using pagination in the REST API.”
Responses
Section titled “ Responses ”Response
Event
object
Actor
object
object
Actor
object
object
object
object
A Discussion in a repository.
object
object
How the author is associated with the repository.
object
object
The current state of the discussion.
converting means that the discussion is being converted from an issue.
transferring means that the discussion is being transferred from another repository.
The reason for the current state
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
object
Unique identifier for the label.
URL for the label
The name of the label.
Optional description of the label, such as its purpose.
6-character hex code, without the leading #, identifying the color
Whether this label comes by default in a new repository.
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
object
URL for the issue
Number uniquely identifying the issue within its repository
State of the issue; either ‘open’ or ‘closed’
The reason for the current state
Title of the issue
Contents of the issue
A GitHub user.
object
Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
object
A GitHub user.
object
A GitHub user.
object
A collection of related issues and pull requests.
object
The number of the milestone.
The state of the milestone.
The title of the milestone.
A GitHub user.
object
object
A GitHub user.
object
The type assigned to the issue. This is only present for issues in repositories where issue types are supported.
object
The unique identifier of the issue type.
The node identifier of the issue type.
The name of the issue type.
The description of the issue type.
The color of the issue type.
The time the issue type created.
The time the issue type last updated.
The enabled state of the issue type.
A repository on GitHub.
object
Unique identifier of the repository
The name of the repository.
License Simple
object
object
A GitHub user.
object
Whether the repository is private or public.
The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
The default branch of the repository.
Whether this repository acts as a template that can be used to generate new repositories.
Whether issues are enabled.
Whether projects are enabled.
Whether the wiki is enabled.
Whether downloads are enabled.
Whether discussions are enabled.
Whether pull requests are enabled.
The policy controlling who can create pull requests: all or collaborators_only.
Whether the repository is archived.
Returns whether or not this repository disabled.
The repository visibility: public, private, or internal.
Whether to allow rebase merges for pull requests.
Whether to allow squash merges for pull requests.
Whether to allow Auto-merge to be used on pull requests.
Whether to delete head branches when pull requests are merged
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
PR_TITLE- default to the pull request’s title.COMMIT_OR_PR_TITLE- default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
The default value for a squash merge commit message:
PR_BODY- default to the pull request’s body.COMMIT_MESSAGES- default to the branch’s commit messages.BLANK- default to a blank commit message.
The default value for a merge commit title.
PR_TITLE- default to the pull request’s title.MERGE_MESSAGE- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
The default value for a merge commit message.
PR_TITLE- default to the pull request’s title.PR_BODY- default to the pull request’s body.BLANK- default to a blank commit message.
Whether to allow merge commits for pull requests.
Whether to allow forking this repo
Whether to require contributors to sign off on web-based commits
Whether anonymous git access is enabled for this repository
The status of the code search index for this repository
object
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.
object
Unique identifier of the GitHub app
The slug name of the GitHub app
A GitHub user.
object
An enterprise on GitHub.
object
A short description of the enterprise.
The enterprise’s website URL.
Unique identifier of the enterprise
The name of the enterprise.
The slug url identifier for the enterprise.
The name of the GitHub app
The set of permissions for the GitHub app
object
The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
How the author is associated with the repository.
object
object
URL to get the parent issue of this issue, if it is a sub-issue
Comments provide a way for people to collaborate on an issue.
object
Unique identifier of the issue comment
URL for the issue comment
Contents of the issue comment
A GitHub user.
object
How the author is associated with the repository.
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.
object
Unique identifier of the GitHub app
The slug name of the GitHub app
A GitHub user.
object
An enterprise on GitHub.
object
A short description of the enterprise.
The enterprise’s website URL.
Unique identifier of the enterprise
The name of the enterprise.
The slug url identifier for the enterprise.
The name of the GitHub app
The set of permissions for the GitHub app
object
The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
object
Context around who pinned an issue comment and when it was pinned.
object
A GitHub user.
object
Details about why an issue comment was minimized.
object
The reason the comment was minimized.
object
A value assigned to an issue field
object
Unique identifier for the issue field.
The human-readable name of the issue field.
The data type of the issue field
Details about the selected option (only present for single_select fields)
object
Unique identifier for the option.
The name of the option
The color of the option
Details about the selected options
object
Unique identifier for the option.
The name of the option
The color of the option
A GitHub user.
object
A GitHub user.
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
object
Unique identifier for the label.
URL for the label
The name of the label.
Optional description of the label, such as its purpose.
6-character hex code, without the leading #, identifying the color
Whether this label comes by default in a new repository.
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
object
Unique identifier for the label.
URL for the label
The name of the label.
Optional description of the label, such as its purpose.
6-character hex code, without the leading #, identifying the color
Whether this label comes by default in a new repository.
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
object
URL for the issue
Number uniquely identifying the issue within its repository
State of the issue; either ‘open’ or ‘closed’
The reason for the current state
Title of the issue
Contents of the issue
A GitHub user.
object
Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
object
A GitHub user.
object
A GitHub user.
object
A collection of related issues and pull requests.
object
The number of the milestone.
The state of the milestone.
The title of the milestone.
A GitHub user.
object
object
A GitHub user.
object
The type assigned to the issue. This is only present for issues in repositories where issue types are supported.
object
The unique identifier of the issue type.
The node identifier of the issue type.
The name of the issue type.
The description of the issue type.
The color of the issue type.
The time the issue type created.
The time the issue type last updated.
The enabled state of the issue type.
A repository on GitHub.
object
Unique identifier of the repository
The name of the repository.
License Simple
object
object
A GitHub user.
object
Whether the repository is private or public.
The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
The default branch of the repository.
Whether this repository acts as a template that can be used to generate new repositories.
Whether issues are enabled.
Whether projects are enabled.
Whether the wiki is enabled.
Whether downloads are enabled.
Whether discussions are enabled.
Whether pull requests are enabled.
The policy controlling who can create pull requests: all or collaborators_only.
Whether the repository is archived.
Returns whether or not this repository disabled.
The repository visibility: public, private, or internal.
Whether to allow rebase merges for pull requests.
Whether to allow squash merges for pull requests.
Whether to allow Auto-merge to be used on pull requests.
Whether to delete head branches when pull requests are merged
Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.
The default value for a squash merge commit title:
PR_TITLE- default to the pull request’s title.COMMIT_OR_PR_TITLE- default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
The default value for a squash merge commit message:
PR_BODY- default to the pull request’s body.COMMIT_MESSAGES- default to the branch’s commit messages.BLANK- default to a blank commit message.
The default value for a merge commit title.
PR_TITLE- default to the pull request’s title.MERGE_MESSAGE- default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
The default value for a merge commit message.
PR_TITLE- default to the pull request’s title.PR_BODY- default to the pull request’s body.BLANK- default to a blank commit message.
Whether to allow merge commits for pull requests.
Whether to allow forking this repo
Whether to require contributors to sign off on web-based commits
Whether anonymous git access is enabled for this repository
The status of the code search index for this repository
object
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.
object
Unique identifier of the GitHub app
The slug name of the GitHub app
A GitHub user.
object
An enterprise on GitHub.
object
A short description of the enterprise.
The enterprise’s website URL.
Unique identifier of the enterprise
The name of the enterprise.
The slug url identifier for the enterprise.
The name of the GitHub app
The set of permissions for the GitHub app
object
The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
How the author is associated with the repository.
object
object
URL to get the parent issue of this issue, if it is a sub-issue
Comments provide a way for people to collaborate on an issue.
object
Unique identifier of the issue comment
URL for the issue comment
Contents of the issue comment
A GitHub user.
object
How the author is associated with the repository.
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.
object
Unique identifier of the GitHub app
The slug name of the GitHub app
A GitHub user.
object
An enterprise on GitHub.
object
A short description of the enterprise.
The enterprise’s website URL.
Unique identifier of the enterprise
The name of the enterprise.
The slug url identifier for the enterprise.
The name of the GitHub app
The set of permissions for the GitHub app
object
The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
object
Context around who pinned an issue comment and when it was pinned.
object
A GitHub user.
object
Details about why an issue comment was minimized.
object
The reason the comment was minimized.
object
A value assigned to an issue field
object
Unique identifier for the issue field.
The human-readable name of the issue field.
The data type of the issue field
Details about the selected option (only present for single_select fields)
object
Unique identifier for the option.
The name of the option
The color of the option
Details about the selected options
object
Unique identifier for the option.
The name of the option
The color of the option
Comments provide a way for people to collaborate on an issue.
object
Unique identifier of the issue comment
URL for the issue comment
Contents of the issue comment
A GitHub user.
object
How the author is associated with the repository.
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.
object
Unique identifier of the GitHub app
The slug name of the GitHub app
A GitHub user.
object
An enterprise on GitHub.
object
A short description of the enterprise.
The enterprise’s website URL.
Unique identifier of the enterprise
The name of the enterprise.
The slug url identifier for the enterprise.
The name of the GitHub app
The set of permissions for the GitHub app
object
The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.
The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
object
Context around who pinned an issue comment and when it was pinned.
object
A GitHub user.
object
Details about why an issue comment was minimized.
object
The reason the comment was minimized.
object
object
A GitHub user.
object
The policy controlling who can create pull requests: all or collaborators_only.
License Simple
object
object
object
object
A GitHub user.
object
object
object
object
object
object
object
object
object
A GitHub user.
object
A GitHub user.
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
object
Unique identifier for the label.
URL for the label
The name of the label.
Optional description of the label, such as its purpose.
6-character hex code, without the leading #, identifying the color
Whether this label comes by default in a new repository.
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
object
Unique identifier for the label.
URL for the label
The name of the label.
Optional description of the label, such as its purpose.
6-character hex code, without the leading #, identifying the color
Whether this label comes by default in a new repository.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
A GitHub user.
object
object
object
object
object
object
object
object
object
object
object
A GitHub user.
object
object
object
object
The name of the tag.
Specifies the commitish value that determines where the Git tag is created from.
True to create a draft (unpublished) release, false to create a published one.
Whether to identify the release as a prerelease or a full release.
Whether or not the release is immutable.
A GitHub user.
object
Data related to a release.
object
The file name of the asset.
State of the release asset.
A GitHub user.
object
The URL of the release discussion.
object
object
Examples
[ { "id": "22249084964", "type": "PushEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "repository_id": 1296269, "push_id": 10115855396, "ref": "refs/heads/master", "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", "before": "883efe034920928c47fe18598c01249d1a9fdabd" }, "public": true, "created_at": "2022-06-09T12:47:28Z" }, { "id": "22196946742", "type": "CreateEvent", "actor": { "id": 583231, "login": "octocat", "display_login": "octocat", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" }, "repo": { "id": 1296269, "name": "octocat/Hello-World", "url": "https://api.github.com/repos/octocat/Hello-World" }, "payload": { "ref": "master", "ref_type": "repository", "full_ref": "refs/heads/master", "master_branch": "master", "description": null, "pusher_type": "user" }, "public": false, "created_at": "2022-06-07T07:50:26Z" }]