Get an app by slug | GitHub API (unofficial showcase)

1 parameter

app_slugstringrequired

The URL-friendly name of the GitHub App, available on its settings page.

3 status codes

200Returns the GitHub App object, including its name, slug, owner, permissions, events, URLs, and timestamps.

idintegerrequired

Unique identifier of the GitHub app

slugstringoptional

The slug name of the GitHub app

node_idstringrequired

client_idstringoptional

ownerobjectrequired

A GitHub user.

namestringrequired

The name of the GitHub app

descriptionstringrequired

external_urlstringrequired

html_urlstringrequired

created_atstringrequired

updated_atstringrequired

permissionsobjectrequired

The set of permissions for the GitHub app

eventsarray<string>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.

installations_countintegeroptional

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

403Returned when access to the requested GitHub App is forbidden.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when no GitHub App is found for the specified slug.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned when access to the app is forbidden. A 404 is returned when no app is found for the app_slug path parameter.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.apps.get({ appSlug: "my-resource" });

{
  "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"
  ]
}

Request

Response

Errors