The identity and technical contract details declared by the specification.
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
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
basic-error
object
Basic Error
4 properties
nullable-scoped-installation
objectnull
7 properties
5 required
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
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties
13 required
app-permissions
object
The permissions granted to the user access token.
45 properties
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
gist-comment
object
A comment made to a gist.
8 properties
8 required
author-association
string
How the author is associated with the repository.
nullable-repository
objectnull
A repository on GitHub.
95 properties
73 required
authentication-token
object
Authentication Token
6 properties
2 required
team-organization
object
Team Organization
48 properties
23 required
team-full
object
Groups of organization members that gives permissions on specified repositories.
18 properties
15 required
runner-groups-org
object
12 properties
7 required
security-and-analysis
objectnull
3 properties
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
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…
team-discussion
object
A team discussion is a persistent record of a free-form conversation within a team.
18 properties
17 required
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-config-insecure-ssl
organization-custom-repository-role-create-schema
object
4 properties
3 required
code-of-conduct-simple
object
Code of Conduct Simple
4 properties
4 required
project
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
reaction-rollup
object
10 properties
10 required
empty-object
object
An object without any properties.
full-repository
object
Full Repository
102 properties
75 required
team-discussion-comment
object
A reply to a discussion within a team.
13 properties
12 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
reaction
object
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
5 properties
5 required
org-hook
object
Org Hook
11 properties
10 required
project-card
object
Project cards represent a scope of work.
13 properties
9 required
project-column
object
Project columns contain cards of work.
8 properties
8 required
empty-object_2
object
An object without any properties.
simple-user_2
object
GitHub user.
21 properties
18 required
authentication-token_2
object
Authentication Token
6 properties
2 required
repository_2
object
repository on GitHub.
95 properties
73 required
nullable-license-simple_2
object
License Simple
6 properties
5 required
validation-error_2
object
Validation Error
3 properties
2 required
autolink
object
An autolink reference.
4 properties
4 required
protected-branch-admin-enforced
object
Protected Branch Admin Enforced
2 properties
2 required
empty-object_3
object
An object without any properties.
hook
object
Webhooks for repositories.
13 properties
12 required
hook-response
object
3 properties
3 required
validation-error_3
object
Validation Error
3 properties
2 required
webhook-config
object
Configuration object of the webhook
4 properties
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
scim-error
object
Scim Error
6 properties
simple-user_3
object
GitHub user.
21 properties
18 required
nullable-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
repository_3
object
repository on GitHub.
95 properties
73 required
validation-error_4
object
Validation Error
3 properties
2 required
nullable-simple-user_2
object
GitHub user.
21 properties
18 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
nullable-milestone
object
collection of related issues and pull requests.
16 properties
16 required
nullable-license-simple_3
object
License Simple
6 properties
5 required
nullable-simple-user_3
object
GitHub user.
21 properties
18 required
project_2
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
link
object
Hypermedia Link
1 property
1 required
pull-request
object
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of…
48 properties
42 required
simple-user_4
object
GitHub user.
21 properties
18 required
validation-error_5
object
Validation Error
3 properties
2 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
auto-merge
object
The status of auto merging a pull request.
4 properties
4 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties
10 required
nullable-simple-user_4
object
GitHub user.
21 properties
18 required
nullable-milestone_2
object
collection of related issues and pull requests.
16 properties
16 required
nullable-license-simple_4
object
License Simple
6 properties
5 required
git-tree
object
The hierarchy between files in a Git repository.
4 properties
4 required
tag-protection
object
Tag protection
5 properties
1 required
check-suite
object
suite of checks performed on the code of a given code change
19 properties
17 required
wait-timer
integer
The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
metadata
object
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
status
object
The status of a commit.
11 properties
11 required
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties
10 required
simple-commit
object
commit.
6 properties
6 required
verification
object
4 properties
4 required
pages-https-certificate
object
4 properties
3 required
pull-request-minimal
object
5 properties
5 required
short-blob
object
Short Blob
2 properties
2 required
release
object
release.
22 properties
17 required
check-run
object
check performed on the code of a given code change
17 properties
16 required
nullable-simple-user_5
object
GitHub user.
21 properties
18 required
snapshot
object
Create a new snapshot of a repository's dependencies.
8 properties
6 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
deployment-reviewer-type
string
The type of reviewer.
git-commit
object
Low-level Git commit operations within a repository
10 properties
10 required
validation-error_6
object
Validation Error
3 properties
2 required
release-asset
object
Data related to a release.
13 properties
13 required
nullable-team-simple_2
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
empty-object_4
object
An object without any properties.
dependency
object
5 properties
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
manifest
object
4 properties
1 required
nullable-license-simple_5
object
License Simple
6 properties
5 required
nullable-repository_2
object
repository on GitHub.
95 properties
73 required
code-of-conduct
object
Code Of Conduct
5 properties
4 required
minimal-repository
object
Minimal Repository
87 properties
46 required
file-commit
object
File Commit
2 properties
2 required
security-and-analysis_2
object
3 properties
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties
7 required
milestone
object
collection of related issues and pull requests.
16 properties
16 required
deployment
object
request for a specific ref(branch,sha,tag) to be deployed
18 properties
14 required
environment
object
Details of a deployment environment
9 properties
7 required
git-ref
object
Git references within a repository
4 properties
4 required
git-tag
object
Metadata for a Git tag
8 properties
7 required
deployment-branch-policy-name-pattern-with-type
object
1 property
1 required
pages-source-hash
object
2 properties
2 required
simple-user_5
object
GitHub user.
21 properties
18 required
nullable-integration_2
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
repository_4
object
repository on GitHub.
95 properties
73 required
page-deployment
object
The GitHub Pages deployment status.
3 properties
2 required
page
object
The configuration for GitHub Pages for a repository.
12 properties
5 required
deploy-key
object
An SSH key granting access to a single repository.
9 properties
7 required
commit-comment
object
Commit Comment
14 properties
13 required
code-of-conduct-simple_2
object
Code of Conduct Simple
4 properties
4 required
full-repository_2
object
Full Repository
102 properties
75 required
deployment-status
object
The status of a deployment.
15 properties
11 required
deployment-branch-policy-settings
object
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.