How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Apps API

The Apps API from GitHub — 23 operation(s) for apps.

GitHub Apps API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 29 operations across 23 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}/api/v3.

29 operations 23 paths 23 schemas 6 DELETE14 GET2 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Contact
License
Terms of Service
Resource Areas
1

Paths & Operations 29

Across 23 paths, the API surfaces 29 operations — 6 DELETE, 14 GET, 2 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Apps 29
GET
/app
GitHub Get the Authenticated App
apps/get-authenticated → 200
POST
/app-manifests/{code}/conversions
GitHub Create a GitHub App from a Manifest
apps/create-from-manifest 1 param → 201404422
GET
/app/hook/config
GitHub Get a Webhook Configuration for an App
apps/get-webhook-config-for-app → 200
PATCH
/app/hook/config
GitHub Update a Webhook Configuration for an App
apps/update-webhook-config-for-app body → 200
GET
/app/hook/deliveries
GitHub List Deliveries for an App Webhook
apps/list-webhook-deliveries 3 params → 200400422
GET
/app/hook/deliveries/{delivery_id}
GitHub Get a Delivery for an App Webhook
apps/get-webhook-delivery 1 param → 200400422
POST
/app/hook/deliveries/{delivery_id}/attempts
GitHub Redeliver a Delivery for an App Webhook
apps/redeliver-webhook-delivery 1 param → 202400422
GET
/app/installation-requests
GitHub List Installation Requests for the Authenticated App
apps/list-installation-requests-for-authenticated-app 2 params → 200304401
GET
/app/installations
GitHub List Installations for the Authenticated App
apps/list-installations 4 params → 200
GET
/app/installations/{installation_id}
GitHub Get an Installation for the Authenticated App
apps/get-installation 1 param → 200404
DELETE
/app/installations/{installation_id}
GitHub Delete an Installation for the Authenticated App
apps/delete-installation 1 param → 204404
POST
/app/installations/{installation_id}/access_tokens
GitHub Create an Installation Access Token for an App
apps/create-installation-access-token 1 param body → 201401403404422
PUT
/app/installations/{installation_id}/suspended
GitHub Suspend an App Installation
apps/suspend-installation 1 param → 204404
DELETE
/app/installations/{installation_id}/suspended
GitHub Unsuspend an App Installation
apps/unsuspend-installation 1 param → 204404
DELETE
/applications/{client_id}/grant
GitHub Delete an App Authorization
apps/delete-authorization 1 param body → 204422
POST
/applications/{client_id}/token
GitHub Check a Token
apps/check-token 1 param body → 200404422
PATCH
/applications/{client_id}/token
GitHub Reset a Token
apps/reset-token 1 param body → 200422
DELETE
/applications/{client_id}/token
GitHub Delete an App Token
apps/delete-token 1 param body → 204422
POST
/applications/{client_id}/token/scoped
GitHub Create a Scoped Access Token
apps/scope-token 1 param body → 200401403404422
GET
/apps/{app_slug}
GitHub Get an App
apps/get-by-slug 1 param → 200403404
GET
/installation/repositories
GitHub List Repositories Accessible to the App Installation
apps/list-repos-accessible-to-installation 2 params → 200304401403
DELETE
/installation/token
GitHub Revoke an Installation Access Token
apps/revoke-installation-access-token → 204
GET
/orgs/{org}/installation
GitHub Get an Organization Installation for the Authenticated App
apps/get-org-installation 1 param → 200
GET
/repos/{owner}/{repo}/installation
GitHub Get a Repository Installation for the Authenticated App
apps/get-repo-installation 2 params → 200301404
GET
/user/installations
GitHub List App Installations Accessible to the User Access Token
apps/list-installations-for-authenticated-user 2 params → 200304401403
GET
/user/installations/{installation_id}/repositories
GitHub List Repositories Accessible to the User Access Token
apps/list-installation-repos-for-authenticated-user 3 params → 200304403404
PUT
/user/installations/{installation_id}/repositories/{repository_id}
GitHub Add a Repository to an App Installation
apps/add-repo-to-installation-for-authenticated-user 2 params → 204304403404
DELETE
/user/installations/{installation_id}/repositories/{repository_id}
GitHub Remove a Repository from an App Installation
apps/remove-repo-from-installation-for-authenticated-user 2 params → 204304403404
GET
/users/{username}/installation
GitHub Get a User Installation for the Authenticated App
apps/get-user-installation 1 param → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), app-permissions (45 properties), simple-user (21 properties), nullable-simple-user (21 properties). Each schema is shown below with its type and property counts.

installation
object
Installation
20 properties 17 required
validation-error-simple
object
Validation Error Simple
3 properties 2 required
installation-token
object
Authentication token for a GitHub App installed on a user or org.
8 properties 2 required
scim-error
object
Scim Error
6 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
simple-user
object
A GitHub user.
21 properties 18 required
repository
object
A repository on GitHub.
95 properties 73 required
validation-error
object
Validation Error
3 properties 2 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
basic-error
object
Basic Error
4 properties
integration-installation-request
object
Request to install an integration on a target
5 properties 4 required
nullable-scoped-installation
objectnull
7 properties 5 required
nullable-license-simple
objectnull
License Simple
6 properties 5 required
webhook-config-insecure-ssl
integration
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…
17 properties 11 required
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
11 properties 11 required
nullable-simple-user
objectnull
A GitHub user.
21 properties 18 required
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties 13 required
hook-delivery
object
Delivery made by a webhook.
14 properties 13 required
enterprise
object
An enterprise on GitHub.
10 properties 8 required
app-permissions
object
The permissions granted to the user access token.
45 properties
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config
object
Configuration object of the webhook
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-apps-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Apps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.