GitHub: Apps schemas
5 GitHub schemas with complete fields and constraints.
← Apps operations · All schemas
Get an app — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | 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. |
$ (anyOf 1).client_id | string | Optional | |
$ (anyOf 1).created_at | string | Required within parent | Format: date-time |
$ (anyOf 1).description | JSON | Required within parent | |
$ (anyOf 1).description (anyOf 1) | string | Alternative | |
$ (anyOf 1).description (anyOf 2) | null | Alternative | |
$ (anyOf 1).events | array | Required within parent | 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. |
$ (anyOf 1).events[] | string | Each item | |
$ (anyOf 1).external_url | string | Required within parent | Format: uri |
$ (anyOf 1).html_url | string | Required within parent | Format: uri |
$ (anyOf 1).id | JSON | Required within parent | |
$ (anyOf 1).id (anyOf 1) | integer | Alternative | Unique identifier of the GitHub app |
$ (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).installations_count | JSON | Optional | |
$ (anyOf 1).installations_count (anyOf 1) | integer | Alternative | The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. |
$ (anyOf 1).installations_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).name | string | Required within parent | The name of the GitHub app |
$ (anyOf 1).node_id | string | Required within parent | |
$ (anyOf 1).owner | JSON | Required within parent | |
$ (anyOf 1).owner (anyOf 1) | Model | Alternative | Expand List users — response body — item |
$ (anyOf 1).owner (anyOf 2) | Model | Alternative | Expand Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise |
$ (anyOf 1).permissions | object | Required within parent | The set of permissions for the GitHub app Additional keys: see wildcard field |
$ (anyOf 1).permissions.checks | string | Optional | |
$ (anyOf 1).permissions.contents | string | Optional | |
$ (anyOf 1).permissions.deployments | string | Optional | |
$ (anyOf 1).permissions.issues | string | Optional | |
$ (anyOf 1).permissions.metadata | string | Optional | |
$ (anyOf 1).permissions.* | string | Additional keys | |
$ (anyOf 1).slug | string | Optional | The slug name of the GitHub app |
$ (anyOf 1).updated_at | string | Required within parent | Format: date-time |
$ (anyOf 2) | null | Alternative |
Referenced models: Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise, List users — response body — item
Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An enterprise on GitHub. |
avatar_url | string | Required within parent | Format: uri |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A short description of the enterprise. |
description (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the enterprise |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The name of the enterprise. |
node_id | string | Required within parent | |
slug | string | Required within parent | The slug url identifier for the enterprise. |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
website_url | JSON | Optional | |
website_url (anyOf 1) | string | Alternative | The enterprise's website URL. Format: uri |
website_url (anyOf 2) | null | Alternative |
List subscriptions for the authenticated user — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User Marketplace Purchase |
account | Model | Required within parent | Expand List subscriptions for the authenticated user — response body — item account |
billing_cycle | string | Required within parent | |
free_trial_ends_on | JSON | Required within parent | |
free_trial_ends_on (anyOf 1) | string | Alternative | Format: date-time |
free_trial_ends_on (anyOf 2) | null | Alternative | |
next_billing_date | JSON | Required within parent | |
next_billing_date (anyOf 1) | string | Alternative | Format: date-time |
next_billing_date (anyOf 2) | null | Alternative | |
on_free_trial | boolean | Required within parent | |
plan | Model | Required within parent | Expand List subscriptions for the authenticated user — response body — item plan |
unit_count | JSON | Required within parent | |
unit_count (anyOf 1) | JSON | Alternative | |
unit_count (anyOf 1) (anyOf 1) | integer | Alternative | |
unit_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_count (anyOf 2) | null | Alternative | |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative |
Referenced models: List subscriptions for the authenticated user — response body — item account, List subscriptions for the authenticated user — response body — item plan
List subscriptions for the authenticated user — response body — item account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Format: email |
email (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
login | string | Required within parent | |
node_id | string | Optional | |
organization_billing_email | JSON | Optional | |
organization_billing_email (anyOf 1) | string | Alternative | Format: email |
organization_billing_email (anyOf 2) | null | Alternative | |
type | string | Required within parent | |
url | string | Required within parent | Format: uri |
List subscriptions for the authenticated user — response body — item plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Marketplace Listing Plan |
accounts_url | string | Required within parent | Format: uri |
bullets | array | Required within parent | |
bullets[] | string | Each item | |
description | string | Required within parent | |
has_free_trial | boolean | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
monthly_price_in_cents | JSON | Required within parent | |
monthly_price_in_cents (anyOf 1) | integer | Alternative | |
monthly_price_in_cents (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
price_model | string | Required within parent | Known values: FREE, FLAT_RATE, PER_UNIT |
state | string | Required within parent | |
unit_name | JSON | Required within parent | |
unit_name (anyOf 1) | string | Alternative | |
unit_name (anyOf 2) | null | Alternative | |
url | string | Required within parent | Format: uri |
yearly_price_in_cents | JSON | Required within parent | |
yearly_price_in_cents (anyOf 1) | integer | Alternative | |
yearly_price_in_cents (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |