openapi: 3.0.3
info:
version: 1.1.4
title: GitHub Application About Events API
description: 'Use the REST API to retrieve information about GitHub Apps and GitHub App
installations.'
license:
name: MIT
url: https://spdx.org/licenses/MIT
termsOfService: https://docs.github.com/articles/github-terms-of-service
contact:
name: Support
url: https://support.github.com/contact?tags=dotcom-rest-api
x-github-plan: ghes
x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
variables:
hostname:
description: Self-hosted Enterprise Server hostname
default: HOSTNAME
protocol:
description: Self-hosted Enterprise Server protocol
default: http
tags:
- name: Events
paths:
/repos/{owner}/{repo}/issues/events/{event_id}:
get:
summary: GitHub Get an Issue Event
description: The Get An Issue Event operation retrieves detailed information about a specific event that occurred on an issue within a GitHub repository. By providing the repository owner, repository name, and a unique event ID through the endpoint path parameters, this API returns comprehensive data about that particular issue event, such as when it was created, the type of event (like labeled, assigned, closed, etc.), the actor who triggered the event, and any associated metadata. This is useful for tracking the complete history and timeline of changes made to issues, enabling developers and project managers to audit issue activity, understand workflow patterns, and maintain detailed records of how issues evolved over time within their projects.
tags:
- Events
operationId: getAnIssueEvent
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/events#get-an-issue-event
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- name: event_id
in: path
required: true
schema:
type: integer
example: 42
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/issue-event'
examples:
default:
$ref: '#/components/examples/issue-event'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'410':
$ref: '#/components/responses/gone'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/users/{username}/events/orgs/{org}:
get:
summary: GitHub List Organization Events for the Authenticated User
description: The GitHub Events API endpoint `/users/{username}/events/orgs/{org}` using the GET method retrieves a list of events for the authenticated user within a specific organization. This endpoint allows developers to access activity data related to a particular organization that the authenticated user is associated with, providing visibility into organization-level events and actions. The API returns event data in a paginated format, showing activities such as repository changes, issue updates, pull requests, and other collaborative actions performed within the specified organization context. Authentication is required to access this endpoint, and the results are filtered to show only events relevant to both the specified username and organization that the authenticated user has permission to view.
tags:
- Events
operationId: listOrganizationEventsForTheAuthenticatedUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-organization-events-for-the-authenticated-user
parameters:
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
default:
$ref: '#/components/examples/user-org-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/users/{username}/events/public:
get:
summary: GitHub List Public Events for User
description: The List Public Events For A User operation retrieves a paginated list of public events performed by a specified GitHub user. This GET endpoint accepts a username as a path parameter and returns events such as repository pushes, issue comments, pull requests, and other public activities associated with that user's account. The response includes event metadata like timestamps, event types, and related repository information, making it useful for tracking user contributions and activity across GitHub's public repositories. This endpoint supports pagination parameters and requires no authentication for accessing public event data, though authenticated requests have higher rate limits.
tags:
- Events
operationId: listPublicEventsForUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events-for-a-user
parameters:
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
default:
$ref: '#/components/examples/user-public-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/issues/events:
get:
summary: GitHub List Issue Events for Repository
description: The List Issue Events For Repository endpoint retrieves a paginated list of all issue events that have occurred within a specific repository. This GET operation accepts the repository owner and repository name as path parameters and returns event data such as when issues were opened, closed, reopened, labeled, assigned, or had other state changes applied to them. The endpoint supports pagination through query parameters and requires appropriate authentication to access private repositories, making it useful for tracking issue activity history, generating analytics, or monitoring repository engagement patterns across all issues rather than individual ones.
tags:
- Events
operationId: listIssueEventsForRepository
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/events#list-issue-events-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/issue-event'
examples:
default:
$ref: '#/components/examples/issue-event-items'
headers:
Link:
$ref: '#/components/headers/link'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: events
x-api-evangelist-certified: '2025-07-18'
x-api-naftiko-published: '2025-07-18'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/issues/{issue_number}/events:
get:
summary: GitHub List Issue Events
description: The List Issue Events operation retrieves a chronological list of all events that have occurred on a specific issue within a GitHub repository. By making a GET request to /repos/{owner}/{repo}/issues/{issue_number}/events, developers can access a comprehensive timeline of activities such as labels being added or removed, issue assignments, milestone changes, references from other issues or pull requests, and state changes like when the issue was closed or reopened. This endpoint is particularly useful for tracking the complete history and lifecycle of an issue, understanding how it evolved over time, and gathering data for analytics or auditing purposes. The response includes detailed information about each event type, the actor who triggered it, and the timestamp when it occurred, making it valuable for building issue management tools, generating reports, or implementing custom notification systems.
tags:
- Events
operationId: listIssueEvents
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/events#list-issue-events
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/issue-number'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/issue-event-for-issue'
examples:
default:
$ref: '#/components/examples/issue-event-for-issue-items'
headers:
Link:
$ref: '#/components/headers/link'
'410':
$ref: '#/components/responses/gone'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: events
x-api-evangelist-certified: '2025-07-18'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/issues/{issue_number}/timeline:
get:
summary: GitHub List Timeline Events for an Issue
description: The GitHub Issues API endpoint `/repos/{owner}/{repo}/issues/{issue_number}/timeline` allows you to retrieve a chronological list of all timeline events associated with a specific issue in a repository. This GET operation returns a comprehensive array of events including comments, labels, assignments, cross-references, commits, and state changes that have occurred throughout the issue's lifecycle. You must provide the repository owner, repository name, and issue number as path parameters, and the response includes detailed information about each event such as the event type, actor, timestamp, and relevant metadata. This endpoint is particularly useful for tracking the complete history and activity of an issue, building audit trails, or creating visualizations of issue progression over time.
tags:
- Events
operationId: listTimelineEventsForAnIssue
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/timeline#list-timeline-events-for-an-issue
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/issue-number'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/timeline-issue-events'
examples:
default:
$ref: '#/components/examples/timeline-issue-events'
headers:
Link:
$ref: '#/components/headers/link'
'404':
$ref: '#/components/responses/not_found'
'410':
$ref: '#/components/responses/gone'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: timeline
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/networks/{owner}/{repo}/events:
get:
summary: GitHub List Public Events for Network of Repositories
description: This API operation retrieves a list of public events that have occurred across a network of repositories. By providing the owner and repository name in the path parameters, it returns events not only from the specified repository but also from all forks within that repository's network. The GET request to the /networks/{owner}/{repo}/events endpoint allows developers to monitor activity and track contributions across an entire ecosystem of related repositories, making it useful for understanding collaborative development patterns and staying informed about changes happening throughout a project's fork network.
tags:
- Events
operationId: listPublicEventsForNetworkOfRepositories
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events-for-a-network-of-repositories
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
default:
$ref: '#/components/examples/public-repo-events-items'
'301':
$ref: '#/components/responses/moved_permanently'
'304':
$ref: '#/components/responses/not_modified'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/events:
get:
summary: GitHub List Public Organization Events
description: Lists all public events for an organization. This endpoint returns a paginated list of events that have occurred within the organization, including activities like repository creation, issue comments, pull requests, and other public actions performed by organization members. The events are returned in reverse chronological order, with the most recent events appearing first. Authentication is not required to access this endpoint since it only exposes public events, though authenticated requests receive a higher rate limit. This is useful for monitoring public activity within an organization, building activity feeds, or tracking contributions and engagement across the organization's public repositories.
tags:
- Events
operationId: listPublicOrganizationEvents
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-organization-events
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
200-response:
$ref: '#/components/examples/public-org-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/events:
get:
summary: GitHub List Repository Events
description: '**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.
'
tags:
- Events
operationId: listRepositoryEvents
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-repository-events
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event_2'
examples:
200-response:
$ref: '#/components/examples/repo-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/users/{username}/events:
get:
summary: GitHub List Events for the Authenticated User
description: The GitHub User API endpoint `/users/{username}/events` with the GET method retrieves a chronological list of public events performed by a specified user. This operation allows you to fetch up to 300 public events from the past 90 days associated with the given username, including actions such as pushing commits, creating repositories, opening issues, submitting pull requests, and other activities visible on their public profile. The response returns an array of event objects containing details like event type, repository information, timestamps, and payload data specific to each action, making it useful for tracking user activity, building activity feeds, or analyzing contribution patterns across GitHub.
tags:
- Events
operationId: listEventsForTheAuthenticatedUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-events-for-the-authenticated-user
parameters:
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
default:
$ref: '#/components/examples/user-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
x-api-evangelist-certified: '2025-07-18'
x-api-naftiko-published: '2025-07-18'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/users/{username}/received_events:
get:
summary: GitHub List Events Received by the Authenticated User
description: 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.
tags:
- Events
operationId: listEventsReceivedByTheAuthenticatedUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-events-received-by-the-authenticated-user
parameters:
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
default:
$ref: '#/components/examples/user-received-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/users/{username}/received_events/public:
get:
summary: GitHub List Public Events Received by User
description: Lists the public events received by a user, showing activity from other users that affects the specified user's repositories and interactions. This endpoint returns events such as when someone watches, forks, or creates issues on the user's repositories, or when someone follows the user. The events are limited to public activity only and are returned in chronological order with the most recent events first. Results are paginated with up to 30 events per page, and the API supports standard GitHub pagination headers for navigating through older events. Authentication is optional but recommended to receive a higher rate limit, and the endpoint requires the username as a path parameter to specify which user's received events should be retrieved.
tags:
- Events
operationId: listPublicEventsReceivedByUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events-received-by-a-user
parameters:
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/per-page'
- $ref: '#/components/parameters/page'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/event'
examples:
default:
$ref: '#/components/examples/user-received-public-events-items'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: activity
subcategory: events
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
nullable-simple-user:
title: Simple User
description: A GitHub user.
type: object
properties:
name:
nullable: true
type: string
example: octocat
email:
nullable: true
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
nullable: true
integration:
title: GitHub app
description: 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.
type: object
properties:
id:
description: Unique identifier of the GitHub app
example: 37
type: integer
slug:
description: The slug name of the GitHub app
example: probot-owners
type: string
node_id:
type: string
example: MDExOkludGVncmF0aW9uMQ==
owner:
$ref: '#/components/schemas/nullable-simple-user'
name:
description: The name of the GitHub app
example: Probot Owners
type: string
description:
type: string
example: The description of the app.
nullable: true
external_url:
type: string
format: uri
example: https://example.com
html_url:
type: string
format: uri
example: https://github.com/apps/super-ci
created_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
updated_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
permissions:
description: The set of permissions for the GitHub app
type: object
properties:
issues:
type: string
checks:
type: string
metadata:
type: string
contents:
type: string
deployments:
type: string
additionalProperties:
type: string
example:
issues: read
deployments: write
events:
description: The list of events for the GitHub app
example:
- label
- deployment
type: array
items:
type: string
installations_count:
description: The number of installations associated with the GitHub app
example: 5
type: integer
client_id:
type: string
example: '"Iv1.25b5d1e65ffc4022"'
client_secret:
type: string
example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"'
webhook_secret:
type: string
example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"'
nullable: true
pem:
type: string
example: '"--BEGIN RSA PRIVATE KEY--\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT71
# --- truncated at 32 KB (807 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-events-api-openapi.yml