• Installs:
  • Today: 58
  • This Week: 446
  • This Month: 1410
  • All Time: 19
Developer:userdimashirokov

Github API Package

Manage your repos and follow updates, feeds and events.

List of Endpoints
This is the list of endpoints this API includes. To add of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
user thumbnail
iddogino1: Where can I get an access token...
See All
Readme

Github

GitHub Package

An object oriented wrapper for the GitHub v3 API.

  • Domain: github.com
  • Credentials: accessToken

How to get credentials:

  1. In the top right corner of any page, click your profile photo, then click Settings.
  2. In the user settings sidebar, click Personal access tokens.
  3. Click Generate new token.
  4. Give your token a descriptive name.
  5. Select the scopes you wish to grant to this token.
  6. Click Generate token.
  7. Copy the token to your clipboard. For security reasons, after you navigate off this page, no one will be able to see the token again.

Github.checkNotificationThreadSubscription

Check to see if the current user is subscribed to a thread.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe thread ID (required)

Github.checkRepositoryStarring

Check if you are starring a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.deleteNotificationThreadSubscription

Delete a notification thread subscription.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe thread ID (required)

Github.getPublicEvents

List public events

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationEvents

List public events for an organization

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of organization (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryEvents

List repository events

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryIssuesEvents

List issue events for a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryNetworkEvents

List public events for a network of repositories

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe repository name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserPerformedEvents

List events performed by a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserOrganizationEvents

List events for a user's organization

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
organizationNameStringThe name of the organization (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserPublicPerformedEvents

List public events performed by a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserReceivedEvents

List events that a user has received

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserReceivedPublicEvents

List public events that a user has received

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getFeeds

Get all feeds available for the authenticated user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getNotificationThread

View a single notification thread.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe ID of the thread (required)

Github.getUserNotifications

Get all notifications for the current user, grouped by repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
allStringIf true, show notifications marked as read. Default: false (optional)
participatingStringIf true, only shows notifications in which the user is directly participating or mentioned. Default: false (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
beforeStringOnly show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. (optional)

Github.getUserRepositoryNotifications

Get all notifications for the given user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
allStringIf true, show notifications marked as read. Default: false (optional)
participatingStringIf true, only shows notifications in which the user is directly participating or mentioned. Default: false (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
beforeStringOnly show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. (optional)

Github.getRepositorySubscription

Get a Repository Subscription.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe onwer name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryStargazers

List Stargazers

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getStarredRepositories

List repositories being starred by the authenticated user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserStarredRepositories

List repositories being starred by a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getWatchedRepositories

List repositories being watched by the authenticated user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserWatchedRepositories

List repositories being watched by a user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryWatchers

Get watchers for repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.markNotificationThreadAsRead

Mark a notification thread as read.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe Id of the thread (required)

Github.markNotificationsAsRead

Mark notifications as read for authenticated user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
lastReadAtStringDescribes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: Time.now (optional)

Github.markNotificationsAsReadForRepository

Mark notifications in a repo as read.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
lastReadAtStringDescribes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: Time.now (optional)

Github.setNotificationThreadSubscription

This lets you subscribe or unsubscribe from a conversation. Unsubscribing from a conversation mutes all future notifications (until you comment or get @mentioned once more).

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe ID of the thread (required)
subscribedStringDetermines if notifications should be received from this thread (optional)
ignoredStringDetermines if all notifications should be blocked from this thread (optional)

Github.setRepositorySubscription

Set a Repository Subscription

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
subscribedStringDetermines if notifications should be received from this repository. (optional)
ignoredStringDetermines if all notifications should be blocked from this repository. (optional)

Github.starRepository

Star a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.unstarRepository

Unstar a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.unwatchRepository

Unwatch a repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.checkAuthorization

Check an authorization

FieldTypeDescription
tokenStringThe access token to check. (required)
clientIdStringThe 20 character OAuth app client key for which to create the token. (required)
clientSecretStringThe username obtained from Github. (required)

Github.createAuthorization

Create a new authorization

FieldTypeDescription
scopesArrayA list of scopes that this authorization is in. (optional)
noteStringA note to remind you what the OAuth token is for. (optional)
noteUrlStringA URL to remind you what app the OAuth token is for. (optional)
clientIdStringThe 20 character OAuth app client key for which to create the token. (required)
clientSecretStringThe 40 character OAuth app client secret for which to create the token. (optional)
fingerprintStringA unique string to distinguish an authorization from others created for the same client ID and user. (optional)

Github.deleteAuthorization

Delete an authorization

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
idStringThe authorization ID (required)

Github.deleteGrantAuthorization

Delete a grant. (In preview period. See README.)

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
idStringThe authorization ID (required)

Github.getAuthorization

Get a single authorization

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
twoFactorCodeStringRequired for two-factor auth method. (optional)
idStringThe authorization ID (required)

Github.getAllAuthorization

List your authorizations

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getGrantAuthorization

Get a single grant. (In preview period. See README.)

FieldTypeDescription
idStringThe authorization ID (required)
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
twoFactorCodeStringRequired for two-factor auth method. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getGrantsAuthorization

List your grants. (In preview period. See README.)

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
twoFactorCodeStringRequired for two-factor auth method. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrCreateAuthorizationForApp

Get or create an authorization for a specific app

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
clientIdStringThe 20 character OAuth app client key for which to create the token. (required)
clientSecretStringThe 40 character OAuth app client secret associated with the client ID specified in the URL. (required)
scopesJSONA list of scopes that this authorization is in. (optional)
noteStringA note to remind you what the OAuth token is for. (optional)
noteUrlStringA URL to remind you what app the OAuth token is for. (optional)
fingerprintStringA unique string to distinguish an authorization from others created for the same client ID and user. (optional)

Github.getOrCreateAuthorizationForAppAndFingerprint

Get or create an authorization for a specific app and fingerprint

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
clientIdStringThe 20 character OAuth app client key for which to create the token. (required)
fingerprintStringA unique string to distinguish an authorization from others created for the same client ID and user. (optional)
clientSecretStringThe 40 character OAuth app client secret associated with the client ID specified in the URL. (required)
scopesJSONA list of scopes that this authorization is in. (optional)
noteStringA note to remind you what the OAuth token is for. (optional)
noteUrlStringA URL to remind you what app the OAuth token is for. (optional)

Github.resetAuthorization

Reset an authorization

FieldTypeDescription
tokenStringThe access token to check. (required)
clientIdStringThe 20 character OAuth app client key for which to create the token. (required)
clientSecretStringThe 40 character OAuth app client secret associated with the client ID specified in the URL. (required)

Github.revokeAuthorization

Revoke an authorization for an application

FieldTypeDescription
tokenStringThe access token to check. (required)
clientIdStringThe 20 character OAuth app client key for which to create the token. (required)
clientSecretStringThe 40 character OAuth app client secret associated with the client ID specified in the URL. (required)

Github.updateAuthorization

Update an existing authorization

FieldTypeDescription
usernameStringThe username obtained from Github. (required)
passwordStringThe password obtained from Github. (required)
idStringThe authorization ID (required)
scopesJSONA list of scopes that this authorization is in. (optional)
addScopesJSONA list of scopes to add to this authorization. (optional)
removeScopesJSONA list of scopes to remove from this authorization. (optional)
noteStringA note to remind you what the OAuth token is for. (optional)
noteUrlStringA URL to remind you what app the OAuth token is for. (optional)
fingerprintStringA unique string to distinguish an authorization from others created for the same client ID and user. (optional)

Github.createOrganizationEnterprise

Create an organization

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
loginStringThe organization's username. (required)
adminStringThe login of the user who will manage this organization. (required)
profileNameStringThe organization's display name. (optional)

Github.getLicenseEnterprise

Get license information

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.queueIndexingJobEnterprise

Queue an indexing job

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
targetStringA string representing the item to index. (required)

Github.statsEnterprise

Get statistics.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
typeStringPossible values: issues, hooks, milestones, orgs, comments, pages, users, gists, pulls, repos, all. (required)

Github.syncLdapForTeamEnterprise

Sync LDAP mapping for a team.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
teamIdNumberThe ID of the team (required)

Github.syncLdapForUserEnterprise

Sync LDAP mapping for a user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.updateLdapForTeamEnterprise

Update LDAP mapping for a team.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
teamIdNumberThe ID of the team (required)
dataStringJSON payload with the new LDAP data. (optional). Ex.: {"ldap_dn": "cn=Enterprise Ops,ou=teams,dc=github,dc=com"}

Github.updateLdapForUserEnterprise

Update LDAP mapping for a user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
dataStringJSON payload with the new LDAP data. (optional). Ex.: {"ldap_dn": "uid=asdf,ou=users,dc=github,dc=com"}

Github.checkGistStar

Check if a gist is starred

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist (required)

Github.createGist

Create a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
filesJSONFiles that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content' (required)
descriptionStringA description of the gist. (optional)
publicStringIndicates whether the gist is public. Default: false

Github.createSingleFileGist

Create a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
fileNameStringName of file.
fileContentsStringContents of file.
publicStringIndicates whether the gist is public.

Github.createGistComment

Create a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
gistIdStringId (SHA1 hash) of the gist. (required)
bodyStringThe comment text. (required)

Github.deleteGist

Delete a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)

Github.deleteGistComment

Delete a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
gistIdStringId (SHA1 hash) of the gist. (required)
commentIdStringThe comment ID. (required)

Github.editGist

Edit a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)
descriptionStringA description of the gist. (optional)
filesJSONFiles that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content' (required)

Github.updateGistComment

Edit a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
gistIdStringId (SHA1 hash) of the gist. (required)
commentIdStringThe comment ID. (required)
bodyStringThe comment text. (required)

Github.forkGist

Fork a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)

Github.getGist

Get a single gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)

Github.getAllGists

List the authenticated user's gists or if called anonymously, this will return all public gists

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)

Github.getGistComment

Get a single comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
gistIdStringId (SHA1 hash) of the gist. (required)
idStringThe comment ID. (required)

Github.getGistComments

List comments on a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
gistIdStringId (SHA1 hash) of the gist. (required)

Github.getGistCommits

List gist commits

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)

Github.getUserGists

List a user's gists

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)

Github.getGistForks

List gist forks

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getPublicGists

List all public gists

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)

Github.getGistByRevision

Get a specific revision of a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)
shaStringThe SHA1 hash of the revision (required)

Github.getStarredGists

List the authenticated user's starred gists

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)

Github.starGist

Star a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)

Github.unstarGist

Unstar a gist

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringId (SHA1 hash) of the gist. (required)

Github.createBlob

Create a Blob

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
contentStringThe new blob's content. (required)
encodingStringThe encoding used for content. Currently, "utf-8" and "base64" are supported. Default: "utf-8". (required)

Github.createCommit

Create a Commit

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
messageStringString of the commit message (required)
treeStringString of the SHA of the tree object this commit points to (required)
parentsJSONArray of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided. (required)
authorJSONAn object containing information about the author (optional). Avaliable parameters: "name" (string) The name of the author (or committer) of the commit; "email" (string) The email of the author (or committer) of the commit; "date" (string) Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex.:"author": {"name": "Scott Chacon", "email": "[email protected]", "date": "2008-07-09T16:13:30+12:00"}
committerJSONAn object containing information about the committer (optional). Both the author and committer parameters have the same keys.

Github.createReference

Create a Reference

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringString of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected. (required)
shaStringThe SHA1 value to set this reference to (required)

Github.createTag

Create a Tag Object

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
tagStringString of the tag (required)
messageStringString of the tag message (required)
objectStringString of the SHA of the git object this is tagging (required)
typeStringString of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob. (required)
taggerJSONJSON object that contains the following keys: name - String of the name of the author of the tag, email - String of the email of the author of the tag, date - Timestamp of when this object was tagged (required)

Github.createTree

Create a Tree

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
treeJSONArray of Hash objects (of path, mode, type and sha) specifying a tree structure (required)
baseTreeStringString of the SHA1 of the tree you want to update with new data (optional)

Github.deleteReference

Delete a Reference

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringString of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected. (required)

Github.getBlob

Get a Blob

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe SHA1 value to set this reference to (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getCommit

Get a Commit

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe SHA1 value to set this reference to (required)

Github.getCommitSignatureVerification

Get a Commit Signature Verification. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe SHA1 value to set this reference to (required)

Github.getReference

Get a Reference

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringString of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected. (required)

Github.getReferences

Get all References

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getTag

Get a Tag

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe SHA1 value to set this reference to (required)

Github.getTagSignatureVerification

Get a Tag Signature Verification. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe SHA1 value to set this reference to (required)

Github.getTags

Get all tag References

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getTree

Get a Tree

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe SHA1 value to set this reference to (required)
recursiveStringGet a Tree Recursively (optional). True or false

Github.updateReference

Update a Reference

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringString of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected. (required)
shaStringThe SHA1 value to set this reference to (required)
forceStringBoolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work. (optional)

Github.createInstallation

Create a new access token

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
installationIdNumberThe id of the installation for this integration. (required)
userIdNumberThe id of the user for whom the integration is acting on behalf of. (optional)

Github.addAssigneesToIssue

Add assignees to an issue.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue (required)
assigneesJSONLogins for the users that should be added to the issue. (required)

Github.addIssueLabels

Add labels to an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue (required)
bodyJSONArray of the labels that should be added to the issue. (required)

Github.checkAssignee

Check assignee

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
assigneeStringLogin for the user that this issue should be assigned to. (required)

Github.createIssue

Create an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
titleStringThe title of the issue. (required)
bodyStringThe contents of the issue. (optional)
assigneeStringLogin for the user that this issue should be assigned to. (optional)
milestoneNumberMilestone to associate this issue with. (optional)
labelsJSONArray of strings - Labels to associate with this issue. (optional)
assigneesJSONLogins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. (optional)

Github.createIssueComment

Create a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue (required)
bodyStringThe contents of the comment. (required) Ex.: {"body": "Me too"}

Github.createLabel

Create a label

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
nameStringThe name of the label. (required)
colorString6 character hex code, without a leading #. (required)

Github.createMilestone

Create a milestone

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
titleStringThe title of the milestone. (required)
stateStringThe state of the milestone. Either open or closed. Default: open (optional)
descriptionStringA description of the milestone. (optional)
dueOnStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)

Github.deleteIssueComment

Delete a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
idStringThe ID of the comment (required)

Github.deleteLabel

Delete a label

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
nameStringThe name of the label. (required)

Github.deleteMilestone

Delete a milestone

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the milestone. (required)

Github.updateIssue

Edit an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the issue. (required)
titleStringThe title of the issue. (optional)
bodyStringThe contents of the issue. (optional)
stateStringState of the issue. Either open or closed. (optional)
milestoneNumberMilestone to associate this issue with. (optional)
labelsJSONArray of strings - Labels to associate with this issue. (optional)
assigneesJSONLogins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. .Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. (optional)

Github.updateIssueComment

Edit a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
idStringThe ID of the comment. (required)
bodyStringThe contents of the comment. (required). Ex.: {"body": "Me too"}

Github.getIssue

Get a single issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the issue. (required)

Github.getAllIssues

List all issues across all the authenticated user's visible repositories including owned repositories, member repositories, and organization repositories

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
filterStringIndicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you, * created: Issues created by you, * mentioned: Issues mentioning you, * subscribed: Issues you're subscribed to updates for, * all: All issues the authenticated user can see, regardless of participation or creation, Default: assigned (optional)
stateStringIndicates the state of the issues to return. Can be either open, closed, or all. Default: open (optional)
labelsStringString list of comma separated Label names. Example: bug,ui,@high (optional)
sortStringWhat to sort results by. Can be either created, updated, comments. Default: created (optional)
directionStringThe direction of the sort. Can be either asc or desc. Default: desc (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getAssignees

List assignees

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)

Github.getIssueComment

Get a single comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
idStringThe ID of the comment. (required)

Github.getIssueComments

List comments on an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the issue. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssuesCommentsForRepository

List comments in a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
sortStringEither created or updated. Default: created (optional)
directionStringEither asc or desc. Ignored without the sort parameter. (optional)
sinceStringOnly comments updated at or after this time are returned. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssueEvent

Get a single event

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the reposotiry. (required)
idStringThe ID of the event. (required)

Github.getIssueEvents

List events for an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the issue. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssueEventsForRepository

List events for a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssueEventsTimeline

List events for an issue. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the issue.(required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssuesForOrganization

List all issues for a given organization for the authenticated user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization. (required)
filterStringIndicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you, * created: Issues created by you, * mentioned: Issues mentioning you, * subscribed: Issues you're subscribed to updates for, * all: All issues the authenticated user can see, regardless of participation or creation, Default: assigned (optional)
stateStringIndicates the state of the issues to return. Can be either open, closed, or all. Default: open (optional)
labelsStringString list of comma separated Label names. Example: bug,ui,@high (optional)
sortStringWhat to sort results by. Can be either created, updated, comments. Default: created (optional)
directionStringThe direction of the sort. Can be either asc or desc. Default: desc (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssuesForRepository

List issues for a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
milestoneStringIf an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned. (optional)
stateStringIndicates the state of the issues to return. Can be either open, closed, or all. Default: open (optional)
assigneeStringString User login, none for Issues with no assigned User. * for Issues with any assigned User. (optional)
creatorStringThe user that created the issue. (optional)
mentionedStringA user that's mentioned in the issue. (optional)
labelsStringString list of comma separated Label names. Example: bug,ui,@high (optional)
sortStringWhat to sort results by. Can be either created, updated, comments. Default: created (optional)
directionStringThe direction of the sort. Can be either asc or desc. Default: desc (optional)
sinceStringOnly issues updated at or after this time are returned. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserIssues

List all issues across owned and member repositories for the authenticated user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
filterStringIndicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you, * created: Issues created by you, * mentioned: Issues mentioning you, * subscribed: Issues you're subscribed to updates for, * all: All issues the authenticated user can see, regardless of participation or creation, Default: assigned (optional)
stateStringIndicates the state of the issues to return. Can be either open, closed, or all. Default: open (optional)
labelsStringString list of comma separated Label names. Example: bug,ui,@high (optional)
sortStringWhat to sort results by. Can be either created, updated, comments. Default: created (optional)
directionStringThe direction of the sort. Can be either asc or desc. Default: desc (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getIssueLabels

List labels on an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the issue. (required)

Github.getLabel

Get a single label

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
nameStringThe name of the label. (required)

Github.getRepositoryLabels

List all labels for this repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getMilestone

Get a single milestone

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the milestone. (required)

Github.getMilestoneLabels

Get labels for every issue in a milestone

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name. (required)
repositoryNameStringThe name of the repository. (required)
numberNumberThe number of the milestone. (required)

Github.getRepositoryMilestones

List milestones for a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
stateStringThe state of the milestone. Either open, closed, or all. Default: open (optional)
sortStringWhat to sort results by. Either due_on or completeness. Default: due_on (optional)
directionStringThe direction of the sort. Either asc or desc. Default: asc (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.lockIssue

Users with push access can lock an issue's conversation.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringhe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue. (required)

Github.removeIssueAllLabels

Remove all labels from an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue. (required)

Github.removeAssigneesFromIssue

Remove assignees from an issue.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue. (required)
assigneesJSONLogins for the users that should be removed from the issue. (required). Ex.: "assignees": ["hubot", "other_assignee"]

Github.removeIssueLabel

Remove a label from an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue. (required)
nameStringThe name of the label. (required)

Github.replaceAllIssueLabels

Replace all labels for an issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue. (required)
bodyJSONArray of the labels that should be replaced for the issue. Sending an empty array ([]) will remove all Labels from the Issue. (required)

Github.unlockIssue

Users with push access can unlock an issue's conversation.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue (required)

Github.updateLabel

Update a label

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
oldnameStringThe old name of the label. (required)
nameStringThe new name of the label. (required)
colorString6 character hex code, without a leading #. (required)

Github.updateMilestone

Update a milestone

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the milestone (required)
titleStringThe title of the milestone. (required)
stateStringThe state of the milestone. Either open or closed. Default: open (optional)
descriptionStringA description of the milestone. (optional)
dueOnStringThe milestone due date. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)

Github.cancelImport

Cancel an import. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.deleteMigrationArchive

Delete a migration archive

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe migration ID. (required)

Github.getImportCommitAuthors

Get import commit authors. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
sinceStringOnly authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step. (optional)

Github.getImportProgress

Get import progress. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getLargeImportFiles

List files larger than 100MB found during the import. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
nameStringThe name of the system to import from (required). Supported Subversion, Mercurial, and TFS.

Github.getMigrationArchiveLink

Get the URL to a migration archive.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe ID of the migration (required)

Github.getMigrationStatus

Get the status of a migration

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe ID of the migration (required)

Github.getMigrations

Get a list of migrations

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.mapImportCommitAuthor

Map a commit author. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
authorIdStringThe commit author id. (required)
emailStringThe new Git author email. (optional)
nameStringThe new Git author name. (optional)

Github.setImportLfsPreference

Set import LFS preference. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
systemNameStringThe name of the system to import from (required). Supported Subversion, Mercurial, and TFS.

Github.startImport

Start an import. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
vcsUrlStringThe URL of the originating repository. (required)
vcsStringThe originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. (optional)
vcsUsernameStringIf authentication is required, the username to provide to vcs_url. (optional)
vcsPasswordStringIf authentication is required, the password to provide to vcs_url. (optional)
tfvcProjectStringFor a tfvc import, the name of the project that is being imported. (optional)

Github.startMigration

Start a migration.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
repositoriesJSONA list of arrays indicating which repositories should be migrated. (required)
lockRepositoriesStringIndicates whether repositories should be locked (to prevent manipulation) while migrating data. Default: false. (optional)
excludeAttachmentsStringIndicates whether attachments should be excluded from the migration (to reduce migration archive file size). Default: false. (optional)

Github.unlockRepositoryLockedForMigration

Unlock a repository that was locked for migration.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe ID of the migration (required)
repositoryNameStringThe name of the repository (required)

Github.updateImport

Update existing import. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
dataStringJson object with data to be updating (optional). If no data are provided, the import will be restarted. Ex.: {"vcs": "tfvc", "tfvc_project": "project1", "human_name": "project1 (tfs)"}

Github.getEmojis

Lists all the emojis available to use on GitHub.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getGitignoreTemplate

Get a single gitignore template

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
nameStringThe name of the .gitignore template to get e.g. 'C' (required)

Github.getGitignoreTemplates

Lists available gitignore templates

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getLicense

Get an individual license. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
licenseStringThe name of the license. Ex: mit (required)

Github.getLicenses

List all licenses. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getMeta

This endpoint provides information about GitHub.com, the service. Or, if you access this endpoint on your organization's GitHub Enterprise installation, this endpoint provides information about that installation.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getRateLimit

Get your current rate limit status

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getRepoLicenseMisc

Get the contents of a repository's license. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.renderMarkdown

Render an arbitrary Markdown document

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
textStringThe Markdown text to render (required)
modeStringThe rendering mode, markdown to render a document as plain Markdown, just like README files are rendered. gfm to render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly. (optional)
contextStringThe repository context. Only taken into account when rendering as gfm (optional)

Github.renderMarkdownRaw

Render a Markdown document in raw mode

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
dataStringRaw data to send as the body of the request (required)

Github.addOrganizationMembership

Add or update organization membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)
roleStringThe role to give the user in the organization. (required). * admin - The user will become an owner of the organization, * member - The user will become a non-owner member of the organization. Default: member

Github.addOrganizationTeamMembership

Add team membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
userStringThe user name (required)
roleStringThe role that this user should have in the team. (optional). The role that this user should have in the team. Can be one of: * member - a normal member of the team, * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. Default: member

Github.addOrganizationTeamRepository

Add team repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
organizationNameStringThe name of the organization (required)
repositoryNameStringThe name of the repository (required)
permissionStringpull - team members can pull, but not push or administer this repository, push - team members can pull and push, but not administer this repository, admin - team members can pull, push and administer this repository. (optional)

Github.checkOrganizationMembership

Check membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.checkOrganizationPublicMembership

Check public membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.checkOrganizationTeamRepository

Check if a team manages a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
userStringThe user name (required)
repositoryNameStringThe name of the repository (required)

Github.cancelOrganizationMembership

Conceal a user's membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.createOrganizationHook

Create a hook

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
nameStringMust be passed as "web". (required)
configJSONKey/value pairs to provide settings for this webhook (required). The config object can accept the following keys: *url (Required) - The URL to which the payloads will be delivered; *content_type (string) - The media type used to serialize the payloads. Supported values include json and form. The default is form; *secret (string) - If provided, payloads will be delivered with an X-Hub-Signature header. The value of this header is computed as the [HMAC hex digest of the body, using the secret as the key][hub-signature]; *insecure_ssl (string) - Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include "0" (verification is performed) and "1" (verification is not performed). The default is "0". We strongly recommend not setting this to "1" as you are subject to man-in-the-middle and other attacks.
eventsJSONDetermines what events the hook is triggered for. Default: ["push"]. (optional)
activeStringDetermines whether the hook is actually triggered on pushes. (optional)

Github.createOrganizationTeam

Create team

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
nameStringThe name of the team. (required)
descriptionStringThe description of the team. (optional)
repoNamesJSONThe full name (e.g., "organization-name/repository-name") of repositories to add the team to. (optional)
privacyStringThe level of privacy this team should have. (optional). Can be one of: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret

Github.deleteOrganizationHook

Delete a hook

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe hook ID (required)

Github.deleteOrganizationTeam

Method description

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)

Github.deleteOrganizationTeamRepository

Remove team repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.editOrganizationHook

Edit a hook

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe hook ID (required)
configJSONKey/value pairs to provide settings for this webhook (required). The config object can accept the following keys: *url (Required) - The URL to which the payloads will be delivered; *content_type (string) - The media type used to serialize the payloads. Supported values include json and form. The default is form; *secret (string) - If provided, payloads will be delivered with an X-Hub-Signature header. The value of this header is computed as the [HMAC hex digest of the body, using the secret as the key][hub-signature]; *insecure_ssl (string) - Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include "0" (verification is performed) and "1" (verification is not performed). The default is "0". We strongly recommend not setting this to "1" as you are subject to man-in-the-middle and other attacks.
eventsJSONDetermines what events the hook is triggered for. Default: ["push"]. (optional)
activeStringDetermines whether the hook is actually triggered on pushes. (optional)

Github.editOrganizationTeam

Edit team

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
nameStringThe name of the team. (required)
descriptionStringThe description of the team. (optional)
privacyStringThe level of privacy this team should have. (optional). Can be one of: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret

Github.getOrganization

Get an organization

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getAllOrganizations

List all organizations

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
sinceStringThe integer ID of the last Organization that you've seen. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserOrganizations

List organizations for the authenticated user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationHook

Get single hook

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe hook ID (required)

Github.getOrganizationHooks

List hooks

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationMembers

Members list

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
filterStringFilter members returned in the list. (optional). Can be one of: * 2fa_disabled: Members without two-factor authentication enabled. Available for organization owners. * all: All members the authenticated user can see.
roleStringFilter members returned by their role. (optional). Can be one of: * all: All members of the organization, regardless of role. * admin: Organization owners. * member: Non-owner organization members. Default: all
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationMembership

Get organization membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.getOrganizationMemberships

List your organization memberships

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
stateStringIndicates the state of the memberships to return. Can be either active or pending. If not specified, both active and pending memberships are returned. (optional)

Github.getOrganizationPublicMembers

Public members list

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)

Github.getOrganizationTeam

Get team

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)

Github.getOrganizationTeamMembers

Method description

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID(required)
roleStringFilters members returned by their role in the team. (optional). Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team. Default: all
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationTeamMembership

Get team membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
userStringThe user name (required)

Github.getOrganizationTeamRepositories

Get team repos

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationTeams

List teams

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.pingOrganizationHook

Ping a hook

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
idStringThe hook ID (required)

Github.publicizeOrganizationMembership

Publicize a user's membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.removeOrganizationMember

Remove a member

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.removeOrganizationMembership

Remove organization membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
userStringThe user name (required)

Github.removeOrganizationTeamMembership

Remove team membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe team ID (required)
userStringThe user name (required)

Github.updateOrganization

Edit an organization

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
billingEmailStringBilling email address. This address is not publicized. (optional)
companyStringThe company name. (optional)
emailStringThe publicly visible email address. (optional)
locationStringThe location. (optional)
nameStringThe shorthand name of the company. (optional)
descriptionStringThe description of the company. (optional)

Github.checkMergedPullRequest

Get if a pull request has been merged

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.createPullRequest

Create a pull request

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
titleStringThe title of the pull request. (required)
headStringThe branch (or git ref) where your changes are implemented. (required). For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
baseStringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repositoryName that requests a merge to a base of another repositoryName. (required)
bodyStringThe contents of the pull request. (optional)

Github.createPullRequestComment

Create a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
bodyStringThe text of the comment (required)
commitIdStringSha of the commit to comment on. (required)
pathStringRelative path of the file to comment on. (required)
positionNumberColumn index in the diff to comment on. (required)

Github.createPullRequestCommentReply

Reply to existing pull request comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
bodyStringThe text of the comment (required)
inReplyToNumberThe comment id to reply to. (required)

Github.createPullRequestFromIssue

Create a pull request from an existing issue

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
issueNumberThe issue number in this repository to turn into a Pull Request. (required)
headStringThe branch (or git ref) where your changes are implemented. (required)
baseStringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repositoryName that requests a merge to a base of another repositoryName. (required)

Github.deletePullRequestComment

Delete a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the comment (required)

Github.editPullRequestComment

Edit a comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the comment (required)
bodyStringThe text of the comment (required)

Github.getPullRequest

Get a single pull request

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)

Github.getAllPullRequests

List pull requests

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
stateStringEither open, closed, or all to filter by state. Default: open (optional)
headStringFilter pulls by head user and branch name in the format of user:ref-name. Example: github:new-script-format. (optional)
baseStringFilter pulls by base branch name. Example: gh-pages. (optional)
sortStringPossible values are: created, updated, popularity, long-running, Default: created (optional)
directionStringThe direction of the sort. Can be either asc or desc. Default: desc, when sort is created or sort is not specified, otherwise asc. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getPullRequestComment

Get a single comment

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the comment (required)

Github.getPullRequestComments

List comments on a pull request

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getPullRequestCommentsForRepository

List comments in a repository

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
sortStringPossible values are: created, updated, Default: created (optional)
directionStringCan be either asc or desc. Ignored without sort parameter. (optional)
sinceStringOnly comments updated at or after this time are returned. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getPullRequestCommits

List commits on a pull request

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getPullRequestFiles

List pull requests files

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.mergePullRequest

Merge a pull request (Merge Button)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
commitTitleStringTitle for the automatic commit message. (In preview period. See README.) (optional)
commitMessageStringExtra detail to append to automatic commit message. (optional)
shaStringSHA that pull request head must match to allow merge (optional)
mergeMethodStringMerge method to use. Possible values are merge, squash, or rebase. (In preview period. See README.) (optional)

Github.updatePullRequest

Update a pull request

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the pull request (required)
titleStringThe title of the pull request. (optional)
bodyStringThe contents of the pull request. (optional)
stateStringState of this Pull Request. Either open or closed. (optional)
baseStringThe name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. (optional)

Github.createReactionForCommitComment

Create reaction for a commit comment. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
contentStringThe reaction type. (required)

Github.createReactionForIssue

Create reaction for an issue. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringTe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberTne number of the issue (required)
contentStringThe reaction type. (required)

Github.createReactionForIssueComment

Create reaction for an issue comment. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
contentStringThe reaction type. (required)

Github.createReactionForPullRequestReviewComment

Create reaction for a pull request review comment. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
contentStringThe reaction type. (required)

Github.deleteReaction

Delete a reaction. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe reaction ID (required)

Github.getReactionForCommitComment

List reactions for a commit comment. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
contentStringIndicates which type of reaction to return. (optional)

Github.getReactionForIssue

List reactions for an issue. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the issue (required)
contentStringIndicates which type of reaction to return. (optional)

Github.getReactionForIssueComment

List reactions for an issue comment. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
contentStringIndicates which type of reaction to return. (optional)

Github.getReactionForPullRequestReviewComment

List reactions for a pull request review comment. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
contentStringIndicates which type of reaction to return. (optional)

Github.addRepositoryCollaborator

Add user as a collaborator

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
collabuserStringThe name of the collaborator (required)
permissionStringpull - can pull, but not push to or administer this repository, push - can pull and push, but not administer this repository, admin - can pull, push and administer this repository. (optional)

Github.addProtectedBranchRequiredStatusChecksContexts

Add required status checks contexts of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe branch name (required)
bodyJSONAn array of protected branch required status checks contexts (e.g. continuous-integration/jenkins). (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.addProtectedBranchTeamRestrictions

Add team restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
bodyJSONAn array of team slugs (e.g. justice-league). (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.addProtectedBranchUserRestrictions

Add user restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
bodyJSONAn array of team slugs (e.g. justice-league). (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.checkRepositoryCollaborator

Check if user is a collaborator.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
collabuserStringThe name of the collaborator (required)

Github.compareRepositoryCommits

Compare two commits.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
baseStringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repositoryName that requests a merge to a base of another repositoryName. (required)
headStringThe branch (or git ref) where your changes are implemented. (required)

Github.createRepository

Create a new repository for the authenticated user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
nameStringThe name of the repository (required)
descriptionStringA short description of the repository (optional)
homepageStringA URL with more information about the repository (optional)
privateStringTrue to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false. (optional)
hasIssuesStringTrue to enable issues for this repository, false to disable them. Default is true. (optional)
hasWikiStringTrue to enable the wiki for this repository, false to disable it. Default is true. (optional)
hasDownloadsStringTrue to enable downloads for this repository, false to disable them. Default is true. (optional)
teamIdStringThe id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. (optional)
autoInitStringTrue to create an initial commit with empty README. Default is false (optional)
gitignoreTemplateStringDesired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided. (optional)
licenseTemplateStringDesired LICENSE template to apply. Use the name of the template without the extension. For example, "mit" or "mozilla". (optional)
allowSquashMergeStringEither true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true. (In preview period. See README.) (optional)
allowMergeCommitStringEither true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true. (In preview period. See README.) (optional)
allowRebaseMergeStringEither true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true. (In preview period. See README.) (optional)

Github.createRepositoryCommitComment

Create a commit comment.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringSHA1 hash of the commit (required)
bodyStringThe contents of the comment. (required)
pathStringRelative path of the file to comment on. (optional)
positionNumberLine index in the diff to comment on. (optional)

Github.createRepositoryDeployment

Create a deployment.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringThe ref to deploy. This can be a branch, tag, or sha. (required)
taskStringThe named task to execute. e.g. deploy or deploy:migrations. Default: deploy (optional)
autoMergeStringOptional parameter to merge the default branch into the requested ref if it is behind the default branch. Default: true (optional)
requiredContextsJSONOptional array of status contexts verified against commit status checks. If this parameter is omitted from the parameters then all unique contexts will be verified before a deployment is created. To bypass checking entirely pass an empty array. Defaults to all unique contexts. (optional)
payloadStringOptional JSON payload with extra information about the deployment. Default: "" (optional)
environmentStringThe name of the environment that was deployed to. e.g. staging or production. Default: none. (optional)
descriptionStringOptional short description. Default: "" (optional)
transientEnvironmentStringSpecifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false. (In preview period. See README.) (optional)
productionEnvironmentStringSpecifies if the given environment is a one that end-users directly interact with. Default: true when environment is production and false otherwise. (In preview period. See README.) (optional)

Github.createRepositoryDeploymentStatus

Create a deployment status.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe deployment ID (required)
stateStringThe state of the status. Can be one of pending, success, error, or failure. (optional)
targetUrlStringThe target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Default: "" (optional)
logUrlStringFunctionally equivalent to target_url. Default: "". (In preview period. See README.) (optional)
descriptionStringA short description of the status. Default: "" (optional)
environmentUrlStringURL for accessing the deployment environment. Default: "". (In preview period. See README.) (optional)
autoInactiveStringWhen true the new inactive status is added to all other non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. Default: true. (In preview period. See README.) (optional)

Github.createRepositoryFile

Create a new file in the given repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pathStringThe content path. (required)
messageStringThe commit message. (required)
contentStringThe new file content, Base64 encoded. (required)
branchStringThe branch name. If not provided, uses the repository’s default branch (usually master). (optional)
committerJSONObject containing information about the committer. You must provide values for both name and email (optional). Ex.: "committer": {"name": "Scott Chacon", "email": "[email protected]"}

Github.createRepositoryForOrganization

Create a new repository for an organization.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
nameStringThe name of the repository (required)
descriptionStringA short description of the repository (optional)
homepageStringA URL with more information about the repository (optional)
privateStringTrue to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false. (optional)
hasIssuesStringTrue to enable issues for this repository, false to disable them. Default is true. (optional)
hasWikiStringTrue to enable the wiki for this repository, false to disable it. Default is true. (optional)
hasDownloadsStringTrue to enable downloads for this repository, false to disable them. Default is true. (optional)
teamIdNumberThe id of the team that will be granted access to this repository. This is only valid when creating a repositoryName in an organization. (optional)
autoInitStringTrue to create an initial commit with empty README. Default is false (optional)
gitignoreTemplateStringDesired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided. (optional)
licenseTemplateStringDesired LICENSE template to apply. Use the name of the template without the extension. For example, "mit" or "mozilla". (optional)
allowSquashMergeStringEither true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true. (In preview period. See README.) (optional)
allowMergeCommitStringEither true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true. (In preview period. See README.) (optional)
allowRebaseMergeStringEither true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true. (In preview period. See README.) (optional)

Github.createRepositoryHook

Create a hook.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
nameStringUse web for a webhook or use the name of a valid service. (required)
configJSONA Hash containing key/value pairs to provide settings for this hook. These settings vary between the services and are defined in the github-services repositoryName. Booleans are stored internally as 1 for true, and 0 for false. Any JSON true/false values will be converted automatically. (required)
eventsJSONDetermines what events the hook is triggered for. Default: ['push']. (optional)
activeStringDetermines whether the hook is actually triggered on pushes. (optional)

Github.createRepositoryKey

Add a new deploy key.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
titleStringA name for the key. (required)
keyStringThe contents of the key. (required)
readOnlyStringIf true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. (optional)

Github.createRepositoryProject

Create a project.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
nameStringThe name of the project (required)
bodyStringThe body of the project (required)

Github.createRepositoryProjectCard

Create a project card.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe column ID (required)
noteStringThe note of the card. (optional)
contentIdStringThe id of the Issue or Pull Request to associate with this card. (optional)
contentTypeStringThe type of content to associate with this card. Can be either 'Issue' or 'PullRequest'. (optional)

Github.createRepositoryProjectColumn

Create a project column.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the project (required)
nameStringThe name of the column. (required)

Github.createRepositoryRelease

Create a release.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
tagNameStringString of the tag (required)
targetCommitishStringSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master). (optional)
nameStringThe name of the release (optional)
bodyStringText describing the contents of the tag. (optional)
draftStringtrue to create a draft (unpublished) release, false to create a published one. Default: false (optional)
prereleaseStringtrue to identify the release as a prerelease. false to identify the release as a full release. Default: false (optional)

Github.createRepositoryStatus

Create a status.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringSHA1 hash of the status (required)
stateStringState of the status - can be one of pending, success, error, or failure. (required)
targetUrlStringTarget url to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the ‘source’ of the Status. (optional)
descriptionStringShort description of the status. (optional)
contextStringA string label to differentiate this status from the status of other systems. (optional)

Github.deleteRepository

Delete a repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.deleteRepositoryAsset

Delete a release asset.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe asset ID (required)

Github.deleteRepositoryCommitComment

Delete a commit comment.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)

Github.deleteRepositoryDownload

Delete a download.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe download ID (required)

Github.deleteRepositoryFile

Delete a file.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pathStringThe content path. (required)
messageStringThe commit message. (required)
shaStringThe blob SHA of the file being removed. (required)
branchStringThe branch name. If not provided, uses the repository’s default branch (usually master). (optional)
committerJSONObject containing information about the committer. You must provide values for both name and email (optional). Ex.: "committer": {"name": "Scott Chacon", "email": "[email protected]"} (optional)

Github.deleteRepositoryHook

Deleate a hook.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe hook ID (required)

Github.deleteRepositoryInvite

Delete a repository invitation. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
repositoryNameStringThe name of the repository (required)
idStringThe invitation ID (required)

Github.deleteRepositoryKey

Remove a deploy key.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe key ID (required)

Github.deleteRepositoryProject

Delete a project.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the project (required)

Github.deleteRepositoryProjectCard

Delete a project card.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe card ID (required)

Github.deleteRepositoryProjectColumn

Delete a project column.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe column ID (required)

Github.deleteRepositoryRelease

Delete a release

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe release ID (required)

Github.editRepository

Update a repo.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
nameStringThe name of the repository (required)
descriptionStringA short description of the repository (optional)
homepageStringA URL with more information about the repository (optional)
privateStringTrue to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false. (optional)
hasIssuesStringTrue to enable issues for this repository, false to disable them. Default is true. (optional)
hasWikiStringTrue to enable the wiki for this repository, false to disable it. Default is true. (optional)
hasDownloadsStringTrue to enable downloads for this repository, false to disable them. Default is true. (optional)
defaultBranchStringUpdates the default branch for this repository. (optional)
allowSquashMergeStringEither true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true. (In preview period. See README.) (optional)
allowMergeCommitStringEither true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true. (In preview period. See README.) (optional)
allowRebaseMergeStringEither true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true. (In preview period. See README.) (optional)

Github.editRepositoryAsset

Edit a release asset.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe asset ID (required)
nameStringThe file name of the asset (required)
labelStringAn alternate short description of the asset. Used in place of the filename. (optional)

Github.editRepositoryHook

Edit a hook.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe hook ID (required)
configJSONA Hash containing key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between the services and are defined in the github-services repositoryName. Booleans are stored internally as 1 for true, and 0 for false. Any JSON true/false values will be converted automatically. (required)
eventsJSONDetermines what events the hook is triggered for. This replaces the entire array of events. Default: ['push']. (optional)
addEventsJSONDetermines a list of events to be added to the list of events that the Hook triggers for. (optional)
removeEventsJSONDetermines a list of events to be removed from the list of events that the Hook triggers for. (optional)
activeStringDetermines whether the hook is actually triggered on pushes. (optional)

Github.editRepositoryRelease

Edit a release.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe release ID (required)
tagNameStringString of the tag (required)
targetCommitishStringSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master). (optional)
nameStringThe name of the release. (optional)
bodyStringText describing the contents of the tag. (optional)
draftStringtrue to create a draft (unpublished) release, false to create a published one. Default: false (optional)
prereleaseStringtrue to identify the release as a prerelease. false to identify the release as a full release. Default: false (optional)

Github.forkRepository

Create a fork.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
organizationStringOptional parameter to specify the organization name if forking into an organization. (optional)

Github.getRepository

Get a repo for a user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getAllRepositories

List your repositories

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
visibilityStringCan be one of all, public, or private. Default: all. (optional)
affiliationStringComma-separated list of values. Can include: owner, collaborator, organization_member. (optional)
typeStringPossible values: all, owner, public, private, member. Default: all. (optional)
sortStringPossible values: created, updated, pushed, full_name. Default: full_name. (optional)
directionString(optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryAllCommitComments

List commit comments for a repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryArchiveLink

Get archive link.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
archiveFormatStringEither tarball or zipball, Deafult: tarball. (required)
refStringString of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected. (optional)

Github.getRepositoryAsset

Get a single release asset.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe assetID (required)

Github.getRepositoryBranch

Get branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryBranchProtection

Get branch protection. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryBranches

List branches. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
protectedStringSet to true to only return protected branches (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryById

Get a single repo by id.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe repository ID (required)

Github.getRepositoryClones

Get the total number of clones and breakdown per day or week for the last 14 days.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryCollaborators

List collaborators

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryCombinedStatus

Get the combined status for a specific ref.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringRef to fetch the status for. It can be a SHA, a branch name, or a tag name. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryCommit

Get a single commit.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringSHA1 hash of the commit (required)

Github.getRepositoryCommitComment

Get a single commit comment.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)

Github.getRepositoryCommitComments

List comments for a single commit.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringSHA1 hash of the commit (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryCommits

List commits on a repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringSha or branch to start listing commits from. (optional)
pathStringOnly commits containing this file path will be returned. (optional)
authorStringGitHub login or email address by which to filter by commit author. (optional)
sinceStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
untilStringTimestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryContent

Get the contents of a file or directory in a repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pathStringThe content path. (required)
refStringThe String name of the Commit/Branch/Tag. Defaults to master. (optional)

Github.getRepositoryContributors

Get contributors for the specified repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
anonStringSet to 1 or true to include anonymous contributors in results. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryDeploymentStatuses

List deployment statuses.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe deployment ID (required)

Github.getRepositoryDeployments

List deployments.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringThe short or long sha that was recorded at creation time. Default: none. (optional)
refStringThe name of the ref. This can be a branch, tag, or sha. Default: none. (optional)
taskStringThe name of the task for the deployment. e.g. deploy or deploy:migrations. Default: none. (optional)
environmentStringThe name of the environment that was deployed to. e.g. staging or production. Default: none. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryDownload

Get a single download.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe download ID (required)

Github.getRepositoryDownloads

List downloads for repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getOrganizationRepositories

List repositories for the specified org.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)
typeStringPossible values: all, public, private, forks, sources, member. Default: all. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserRepositories

List public repositories for the specified user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
typeStringPossible values: all, owner, member. Default: owner. (optional)
sortStringPossible values: created, updated, pushed, full_name. Default: full_name. (optional)
directionStringCan be one of asc or desc. Default: when using full_name: asc, otherwise desc (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryForks

List forks.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
sortStringPossible values: newest, oldest, stargazers, default: newest. (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryHook

Get single hook.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe hook ID (required)

Github.getRepositoryHooks

List hooks.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryInvites

List a user's repository invitations. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
repositoryNameStringThe name of the repository (required)

Github.getRepositoryKey

Get a deploy key.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe key ID (required)

Github.getRepositoryKeys

List deploy keys.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryLanguages

Get languages for the specified repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryLatestPagesBuild

Get latest Pages build

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryLatestRelease

Get the latest release.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryPages

Get information about a Pages site. (Use preview header to include additional info.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryPagesBuild

Get a specific Pages build

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe build ID (required)

Github.getRepositoryPagesBuilds

List Pages builds

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryPaths

Get the top 10 popular contents over the last 14 days.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryProject

List a project.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the project (required)

Github.getRepositoryProjectCard

Get project card.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe card ID (required)

Github.getRepositoryProjectCards

List project cards.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe column ID (required)

Github.getRepositoryProjectColumn

Get a project column.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe column ID (required)

Github.getRepositoryProjectColumns

List a project's columns.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the project (required)

Github.getRepositoryProjects

List projects.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getProtectedBranchRequiredStatusChecks

Get required status checks of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getProtectedBranchRequiredStatusChecksContexts

List required status checks contexts of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getProtectedBranchRestrictions

Get restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getProtectedBranchTeamRestrictions

List team restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getProtectedBranchUserRestrictions

List user restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getPublicRepositories

List all public repositories

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
sinceStringThe integer ID of the last Repository that you've seen. (optional)

Github.getRepositoryReadme

Get the README for the given repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringThe name of the commit/branch/tag. Default: the repository’s default branch (usually master) (optional)

Github.getRepositoryReferrers

Get the top 10 referrers over the last 14 days.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryRelease

Get a single release.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe release ID (required)

Github.getRepositoryReleaseByTag

Get a release by tag name.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
tagStringString of the tag (required)

Github.getRepositoryReleases

List releases for a repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryShaOfCommitRef

Get the SHA-1 of a commit reference.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
refStringString of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected. (required)

Github.getRepositoryStatsCodeFrequency

Get the number of additions and deletions per week.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryStatsCommitActivity

Get the last year of commit activity data.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryStatsContributors

Get contributors list with additions, deletions, and commit counts.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryStatsParticipation

Get the weekly commit count for the repository owner and everyone else.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryStatsPunchCard

Get the number of commits per hour in each day.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.getRepositoryStatuses

Get status for a specfic ref.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
shaStringSHA hash of the commit (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryTags

Get tags for the specified repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryTeams

Get teams for the specified repository.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryViews

Get the total number of views and breakdown per day or week for the last 14 days.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryAssets

List assets for a release.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe release ID (required)

Github.mergeRepository

Perform a merge.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
baseStringThe branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repositoryName that requests a merge to a base of another repositoryName. (required)
headStringThe branch (or git ref) where your changes are implemented. (required)
commitMessageStringCommit message to use for the merge commit. If omitted, a default message will be used. (optional)

Github.moveRepositoryProjectCard

Move a project card.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe card ID (required)
positionStringCan be one of first, last, or after:, where is the id value of a column in the same project. (required)
columnIdStringThe id value of a column in the same project. (optional)

Github.moveRepositoryProjectColumn

Move a project column.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe column ID (required)
positionStringCan be one of first, last, or after:, where is the id value of a column in the same project. (required)

Github.pingRepositoryHook

Ping a hook.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe hook ID (required)

Github.removeBranchProtection

Remove branch protection. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.removeRepositoryCollaborator

Remove user as a collaborator.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
collabuserStringThe name of the collaborator (required)

Github.removeProtectedBranchRequiredStatusChecks

Remove required status checks of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.removeProtectedBranchRequiredStatusChecksContexts

Remove required status checks contexts of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.removeProtectedBranchRestrictions

Remove restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.removeProtectedBranchTeamRestrictions

Remove team restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.removeProtectedBranchUserRestrictions

Remove user restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.replaceProtectedBranchRequiredStatusChecksContexts

Replace required status checks contexts of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
bodyJSONAn array of protected branch required status checks contexts (e.g. continuous-integration/jenkins). (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.replaceProtectedBranchTeamRestrictions

Replace team restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
bodyJSONAn array of team slugs (e.g. justice-league). (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.replaceProtectedBranchUserRestrictions

Replace user restrictions of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
bodyJSONAn array of team slugs (e.g. justice-league). (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.requestRepositoryPageBuild

Request a page build. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)

Github.testRepositoryHook

Test a [push] hook.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe hook ID (required)

Github.updateRepositoryBranchProtection

Update branch protection. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
branchStringThe name of the branch (required)
requiredStatusChecksJSONJSON object that contains the following keys: include_admins - Enforce required status checks for repository administrators, strict - Require branches to be up to date before merging, contexts - The list of status checks to require in order to merge into this branch. This object can have the value of null for disabled. (required)
restrictionsJSONJSON object that contains the following keys: users - The list of user logins with push access, teams - The list of team slugs with push access. This object can have the value of null for disabled. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.updateRepositoryCommitComment

Update a commit comment.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe comment ID (required)
bodyStringThe contents of the comment (required)

Github.updateRepositoryFile

Update a file.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
pathStringThe content path. (required)
messageStringThe commit message. (required)
contentStringThe updated file content, Base64 encoded. (required)
shaStringThe blob SHA of the file being replaced. (required)
branchStringThe branch name. If not provided, uses the repository’s default branch (usually master). (optional)
committerJSONObject containing information about the committer. You must provide values for both name and email (optional). Ex.: "committer": {"name": "Scott Chacon", "email": "[email protected]"} (optional)

Github.updateRepositoryInvite

Update a repository invitation. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
repositoryNameStringThe name of the repository (required)
idStringThe invitation ID (required)
permissionStringThe permissions that the associated user will have on the repository. (optional)

Github.updateRepositoryProject

Update a project.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
numberNumberThe number of the project (required)
nameStringThe name of the project (required)
bodyStringThe body of the project (required)

Github.updateRepositoryProjectCard

Update a project card.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe card ID (required)
noteStringThe note of the card. (optional)

Github.updateRepositoryProjectColumn

Update a project column.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe name of the repository (required)
idStringThe column ID (required)
nameStringThe new name of the column (required)

Github.updateProtectedBranchRequiredStatusChecks

Update required status checks of protected branch. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe new name of the column (required)
branchStringThe branch name (required)
bodyJSONJSON object that contains the following keys: include_admins - Enforce required status checks for repository administrators, strict - Require branches to be up to date before merging, contexts - The list of status checks to require in order to merge into this branch. (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.uploadRepositoryAsset

Upload a release asset.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe owner name (required)
repositoryNameStringThe new name of the repository (required)
idStringThe release ID (required)
filepathStringThe file path of the asset. (required)
nameStringThe file name of the asset. This should be set in a URI query parameter. (required)
labelStringAn alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter. (optional)

Github.codeSearch

Search code.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
qStringSearch Term (required)
sortStringThe sort field. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: results are sorted by best match. (optional)
orderStringasc or desc (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.emailSearch

Search against public email addresses.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
emailStringThe email address (required)

Github.issuesSearch

Search issues.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
qStringSearch Term (required)
sortStringThe sort field. Can be comments, created, or updated. Default: results are sorted by best match. (optional)
orderStringasc or desc (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.repositorySearch

Search repositories.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
qStringSearch Term (required)
sortStringstars, forks, or updated (optional)
orderStringasc or desc (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.usersSearch

Search users.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
qStringSearch Term (required)
sortStringThe sort field. Can be followers, repositories, or joined. Default: results are sorted by best match. (optional)
orderStringasc or desc (optional)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.acceptRepositoryInvite

Accept a repository invitation. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe invitation ID (required)

Github.addEmails

Add email address(es)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
bodyJSONYou can post a single email address or an array of addresses. (required)

Github.checkFollowing

Check if you are following a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.checkIfOneFollowersOther

Check if one user follows another

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
otherUserStringOther user name (required)

Github.createGpgKey

Create a GPG key. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
armoredPublicKeyStringGPG key contents (required)

Github.createKey

Create a public key

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
titleStringThe key title (required)
keyStringThe SSH key (required)

Github.declineRepositoryInvite

Decline a repository invitation. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe invitation ID (required)

Github.deleteEmails

Delete email address(es)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
bodyJSONYou can post a single email address or an array of addresses. (required)

Github.deleteGpgKey

Delete a GPG key. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe GPG key ID (required)

Github.deleteKey

Delete a public key

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe key ID (required)

Github.demoteUser

Demote a site administrator to an ordinary user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.editOrganizationMembership

Edit your organization membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe new name of the organization (required)
stateStringThe state that the membership should be in. Only "active" will be accepted. (required)

Github.followUser

Follow a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.getUser

Get the authenticated user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getAllUsers

Get all users

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
sinceNumberThe integer ID of the last User that you’ve seen. (optional)

Github.getUserById

Get a single user by GitHub ID

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe GitHub user ID (required)

Github.getUserEmails

List email addresses for a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserFollowers

List the authenticated user's followers

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getFollowersForUser

List a user's followers

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserFollowing

List who the authenticated user is following

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getFollowingForUser

List who a user is following

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getSingleUser

Get a single user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.getGpgKey

Get a single GPG key. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe GPG key ID (required)

Github.getGpgKeys

List your GPG keys. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getKey

Get a single public key

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
idStringThe key ID (required)

Github.getKeys

List your public keys

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getKeysForUser

List public keys for a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getUserOrganizationMembership

Get your organization membership

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
organizationNameStringThe name of the organization (required)

Github.getUserOrganizations

List organizations for the authenticated user.

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.getRepositoryInvites

List a user's repository invitations. (In preview period. See README.)

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.

Github.getUserTeams

Get your teams

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
pageNumberPage number of the results to fetch. (optional)
perPageNumberA custom page size up to 100. Default is 30. (optional)

Github.promoteUser

Promote an ordinary user to a site administrator

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.suspendUser

Suspend a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.unfollowUserUser

Method description

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.unsuspendUser

Unsuspend a user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
userStringThe user name (required)

Github.updateUser

Update the authenticated user

FieldTypeDescription
accessTokencredentialsThe access_token obtained from Github.
nameStringThe new name of the user (optional)
emailStringPublicly visible email address. (optional)
blogStringThe new blog URL of the user. (optional)
companyStringThe new company of the user. (optional)
locationStringThe new location of the user. (optional)
hireableStringThe new hiring availability of the user. (optional)
bioStringThe new short biography of the user. (optional)
x
circle
Github
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view