Get an app

GET

/apps/{app_slug}

[!NOTE] The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

API method documentation

Parameters

Path Parameters

app_slug

required

string

Responses

200

Response

Media type application/json

GitHub app

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

id

required

Unique identifier of the GitHub app

integer

slug

The slug name of the GitHub app

string

node_id

required

string

client_id

string

owner

required

One of:

Simple User

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

id

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

Enterprise

Enterprise

An enterprise on GitHub.

object

description

A short description of the enterprise.

string

nullable

html_url

required

string format: uri

website_url

The enterprise’s website URL.

string format: uri

nullable

id

required

Unique identifier of the enterprise

integer

node_id

required

string

name

required

The name of the enterprise.

string

slug

required

The slug url identifier for the enterprise.

string

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

avatar_url

required

string format: uri

name

required

The name of the GitHub app

string

description

required

string

nullable

external_url

required

string format: uri

html_url

required

string format: uri

created_at

required

string format: date-time

updated_at

required

string format: date-time

permissions

required

The set of permissions for the GitHub app

object

issues

string

checks

string

metadata

string

contents

string

deployments

string

key

additional properties

string

events

required

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.

Array<string>

installations_count

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

integer

Examples

Example default

{
  "id": 1,
  "slug": "octoapp",
  "client_id": "Iv1.ab1112223334445c",
  "node_id": "MDExOkludGVncmF0aW9uMQ==",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "name": "Octocat App",
  "description": "",
  "external_url": "https://example.com",
  "html_url": "https://github.com/apps/octoapp",
  "created_at": "2017-07-08T16:18:44-04:00",
  "updated_at": "2017-07-08T16:18:44-04:00",
  "permissions": {
    "metadata": "read",
    "contents": "read",
    "issues": "write",
    "single_file": "write"
  },
  "events": [
    "push",
    "pull_request"
  ]
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}