GitHub v3 REST API

pre-receive-hook

object
idinteger
namestring
enforcementstring
scriptstring
script_repositoryobject
Show Child Parameters
environmentobject
Show Child Parameters
allow_downstream_configurationboolean
Example

Simple User

object

Simple User

namestring
emailstring
loginstringrequired

Example:octocat

idintegerrequired

Example:1

node_idstringrequired

Example:MDQ6VXNlcjE=

avatar_urlstring(uri)required

Example:https://github.com/images/error/octocat_happy.gif

gravatar_idstringrequired

Example:41d064eb2195891e12d0413f63227ea7

urlstring(uri)required

Example:https://api.github.com/users/octocat

html_urlstring(uri)required

Example:https://github.com/octocat

followers_urlstring(uri)required

Example:https://api.github.com/users/octocat/followers

following_urlstringrequired

Example:https://api.github.com/users/octocat/following{/other_user}

gists_urlstringrequired

Example:https://api.github.com/users/octocat/gists{/gist_id}

starred_urlstringrequired

Example:https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_urlstring(uri)required

Example:https://api.github.com/users/octocat/subscriptions

organizations_urlstring(uri)required

Example:https://api.github.com/users/octocat/orgs

repos_urlstring(uri)required

Example:https://api.github.com/users/octocat/repos

events_urlstringrequired

Example:https://api.github.com/users/octocat/events{/privacy}

received_events_urlstring(uri)required

Example:https://api.github.com/users/octocat/received_events

typestringrequired

Example:User

site_adminbooleanrequired
starred_atstring

Example:"2020-07-09T00:17:55Z"

Example

App Permissions

object

The permissions granted to the user-to-server access token.

actionsstring

The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: read or write.

Allowed values:readwrite

administrationstring

The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: read or write.

Allowed values:readwrite

checksstring

The level of permission to grant the access token for checks on code. Can be one of: read or write.

Allowed values:readwrite

contentsstring

The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: read or write.

Allowed values:readwrite

deploymentsstring

The level of permission to grant the access token for deployments and deployment statuses. Can be one of: read or write.

Allowed values:readwrite

environmentsstring

The level of permission to grant the access token for managing repository environments. Can be one of: read or write.

Allowed values:readwrite

issuesstring

The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: read or write.

Allowed values:readwrite

metadatastring

The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: read or write.

Allowed values:readwrite

packagesstring

The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: read or write.

Allowed values:readwrite

pagesstring

The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: read or write.

Allowed values:readwrite

pull_requestsstring

The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: read or write.

Allowed values:readwrite

repository_hooksstring

The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: read or write.

Allowed values:readwrite

repository_projectsstring

The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: read, write, or admin.

Allowed values:readwriteadmin

secret_scanning_alertsstring

The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: read or write.

Allowed values:readwrite

secretsstring

The level of permission to grant the access token to manage repository secrets. Can be one of: read or write.

Allowed values:readwrite

security_eventsstring

The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: read or write.

Allowed values:readwrite

single_filestring

The level of permission to grant the access token to manage just a single file. Can be one of: read or write.

Allowed values:readwrite

statusesstring

The level of permission to grant the access token for commit statuses. Can be one of: read or write.

Allowed values:readwrite

vulnerability_alertsstring

The level of permission to grant the access token to manage Dependabot alerts. Can be one of: read or write.

Allowed values:readwrite

workflowsstring

The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: write.

Allowed values:write

membersstring

The level of permission to grant the access token for organization teams and members. Can be one of: read or write.

Allowed values:readwrite

organization_administrationstring

The level of permission to grant the access token to manage access to an organization. Can be one of: read or write.

Allowed values:readwrite

organization_hooksstring

The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: read or write.

Allowed values:readwrite

organization_planstring

The level of permission to grant the access token for viewing an organization’s plan. Can be one of: read.

Allowed values:read

organization_projectsstring

The level of permission to grant the access token to manage organization projects and projects beta (where available). Can be one of: read, write, or admin.

Allowed values:readwriteadmin

organization_packagesstring

The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: read or write.

Allowed values:readwrite

organization_secretsstring

The level of permission to grant the access token to manage organization secrets. Can be one of: read or write.

Allowed values:readwrite

organization_self_hosted_runnersstring

The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: read or write.

Allowed values:readwrite

organization_user_blockingstring

The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: read or write.

Allowed values:readwrite

team_discussionsstring

The level of permission to grant the access token to manage team discussions and related comments. Can be one of: read or write.

Allowed values:readwrite

content_referencesstring

The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: read or write.

Allowed values:readwrite

Example

Simple User

object

Simple User

namestring
emailstring
loginstringrequired

Example:octocat

idintegerrequired

Example:1

node_idstringrequired

Example:MDQ6VXNlcjE=

avatar_urlstring(uri)required

Example:https://github.com/images/error/octocat_happy.gif

gravatar_idstringrequired

Example:41d064eb2195891e12d0413f63227ea7

urlstring(uri)required

Example:https://api.github.com/users/octocat

html_urlstring(uri)required

Example:https://github.com/octocat

followers_urlstring(uri)required

Example:https://api.github.com/users/octocat/followers

following_urlstringrequired

Example:https://api.github.com/users/octocat/following{/other_user}

gists_urlstringrequired

Example:https://api.github.com/users/octocat/gists{/gist_id}

starred_urlstringrequired

Example:https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_urlstring(uri)required

Example:https://api.github.com/users/octocat/subscriptions

organizations_urlstring(uri)required

Example:https://api.github.com/users/octocat/orgs

repos_urlstring(uri)required

Example:https://api.github.com/users/octocat/repos

events_urlstringrequired

Example:https://api.github.com/users/octocat/events{/privacy}

received_events_urlstring(uri)required

Example:https://api.github.com/users/octocat/received_events

typestringrequired

Example:User

site_adminbooleanrequired
starred_atstring

Example:"2020-07-09T00:17:55Z"

Example

Scoped Installation

object
permissionsobjectrequired

The permissions granted to the user-to-server access token.

Example:{"contents":"read","issues":"read","deployments":"write","single_file":"read"}

Show Child Parameters
repository_selectionstringrequired

Describe whether all repositories have been selected or there’s a selection involved

Allowed values:allselected

single_file_namestringrequired

Example:config.yaml

has_multiple_single_filesboolean

Example:true

single_file_pathsarray[string]

Example:config.yml, .github/issue_TEMPLATE.md

repositories_urlstring(uri)required

Example:https://api.github.com/users/octocat/repos

accountobjectrequired

Simple User

Show Child Parameters
Example