Use wide Github integration

With Ants & Apps platform you can connect Github with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • RepositoryInvitations

    • listInvitationsForARepository

      GETListInvitationsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • When authenticating as a user, this endpoint will list all currently open repository invitations for that user

      This action when authenticating as a user, this endpoint will list all currently open repository invitations for that user.

      GETListAUsersRepositoryInvitations
    • updateARepositoryInvitation

      PATCHUpdateARepositoryInvitation

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • invitation_id*string

        Invitation_id

      Request body

      • permissionsstring

        The permissions that the associated user will have on the repository. Valid values are read, write, and admin.

    • acceptARepositoryInvitation

      PATCHAcceptARepositoryInvitation

      Request parameters

      • invitation_id*string

        Invitation_id

    • deleteARepositoryInvitation

      DELETEDeleteARepositoryInvitation

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • invitation_id*string

        Invitation_id

    • declineARepositoryInvitation

      DELETEDeclineARepositoryInvitation

      Request parameters

      • invitation_id*string

        Invitation_id

  • Branches

    • listBranches

      GETListBranches

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • protectedboolean

        Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

    • getBranch

      GETGetBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • getBranchProtection

      GETGetBranchProtection

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • getRequiredStatusChecksOfProtectedBranch

      GETGetRequiredStatusChecksOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • listRequiredStatusChecksContextsOfProtectedBranch

      GETListRequiredStatusChecksContextsOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.

      GETGetRequiredSignaturesOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

      GETGetAdminEnforcementOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

      GETGetRestrictionsOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. Lists the teams who have push access to this branch. The list includes child teams.

      GETListTeamsWithAccessToProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. Lists the people who have push access to this branch.

      GETListUsersWithAccessToProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.

      GETListAppsWithAccessToProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.

      POSTAddRequiredSignaturesOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

      POSTAddAdminEnforcementOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • updateBranchProtection

      PUTUpdateBranchProtection

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

      Request body

      • required_status_checks*object

        Require status checks to pass before merging. Set to null to disable.

      • enforce_admins*boolean

        Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

      • required_pull_request_reviews*object

        Require at least one approving review on a pull request, before merging. Set to null to disable.

      • restrictions*object

        Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

      • required_linear_historyboolean

        Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.

      • allow_force_pushesboolean

        Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."

      • allow_deletionsboolean

        Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.

    • replaceRequiredStatusChecksContextsOfProtectedBranch

      PUTReplaceRequiredStatusChecksContextsOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • updateRequiredStatusChecksOfProtectedBranch

      PATCHUpdateRequiredStatusChecksOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

      Request body

      • strictboolean

        Require branches to be up to date before merging.

      • contextsarray

        The list of status checks to require in order to merge into this branch

    • Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled

      This action updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

      PATCHUpdatePullRequestReviewEnforcementOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

      Request body

      • dismissal_restrictionsobject

        Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

      • dismiss_stale_reviewsboolean

        Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

      • require_code_owner_reviewsboolean

        Blocks merging pull requests until code owners have reviewed.

      • required_approving_review_countinteger

        Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

    • removeBranchProtection

      DELETERemoveBranchProtection

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • removeRequiredStatusChecksOfProtectedBranch

      DELETERemoveRequiredStatusChecksOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

      DELETERemovePullRequestReviewEnforcementOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.

      DELETERemoveRequiredSignaturesOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

      DELETERemoveAdminEnforcementOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

    • Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud

      This action protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation. Disables the ability to restrict who can push to this branch.

      DELETERemoveRestrictionsOfProtectedBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • branch*string

        Branch

  • DeployKeys

    • listDeployKeys

      GETListDeployKeys

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getADeployKey

      GETGetADeployKey

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • key_id*string

        Key_id

    • addANewDeployKey

      POSTAddANewDeployKey

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • key*string

        The contents of the key.

      • titlestring

        A name for the key.

      • read_onlyboolean

        If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

    • removeADeployKey

      DELETERemoveADeployKey

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • key_id*string

        Key_id

  • Assignees

    • List the available assignees for issues in a repository

      This action lists the available assignees for issues in a repository.

      GETListAssignees

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Check if a user has permission to be assigned to an issue in this repository

      This action checks if a user has permission to be assigned to an issue in this repository.

      GETCheckAssignee

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • assignee*string

        Assignee

    • Add up to 10 assignees to an issue

      This action adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

      POSTAddAssigneesToAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • assigneesarray

        Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

    • Remove one or more assignees from an issue

      This action removes one or more assignees from an issue.

      DELETERemoveAssigneesFromAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • assigneesarray

        Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

  • Emails

    • List all of your email addresses, and specifies which one is visible to the public

      This action lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.

      GETListEmailAddressesForAUser
    • List your publicly visible email address, which you can set with the Toggle primary email visibility endpoint

      This action lists your publicly visible email address, which you can set with the Toggle primary email visibility endpoint. This endpoint is accessible with the user:email scope.

      GETListPublicEmailAddressesForAUser
    • This endpoint is accessible with the user scope

      This action this endpoint is accessible with the user scope.

      POSTAddEmailAddressEs

      Request body

      • emails*array

        Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

    • Set the visibility for your primary email addresses

      This action sets the visibility for your primary email addresses.

      PATCHTogglePrimaryEmailVisibility

      Request body

      • email*string

        Specify the primary email address that needs a visibility change.

      • visibility*string

        Use public to enable an authenticated user to view the specified email address, or use private so this primary email address cannot be seen publicly.

    • This endpoint is accessible with the user scope

      This action this endpoint is accessible with the user scope.

      DELETEDeleteEmailAddressEs

      Request body

      • emails*array

        Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

  • Labels

    • getLabelsForEveryIssueInAMilestone

      GETGetLabelsForEveryIssueInAMilestone

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • milestone_number*string

        Milestone_number

    • listAllLabelsForThisRepository

      GETListAllLabelsForThisRepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getASingleLabel

      GETGetASingleLabel

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • name*string

        Name

    • listLabelsOnAnIssue

      GETListLabelsOnAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

    • createALabel

      POSTCreateALabel

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • name*string

        The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

      • color*string

        The hexadecimal color code for the label, without the leading #.

      • descriptionstring

        A short description of the label.

    • addLabelsToAnIssue

      POSTAddLabelsToAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • labels*array

        The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    • replaceAllLabelsForAnIssue

      PUTReplaceAllLabelsForAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • labelsarray

        The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

    • updateALabel

      PATCHUpdateALabel

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • name*string

        Name

      Request body

      • new_namestring

        The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

      • colorstring

        The hexadecimal color code for the label, without the leading #.

      • descriptionstring

        A short description of the label.

    • removeAllLabelsFromAnIssue

      DELETERemoveAllLabelsFromAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

    • deleteALabel

      DELETEDeleteALabel

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • name*string

        Name

    • Remove the specified label from the issue, and returns the remaining labels on the issue

      This action removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.

      DELETERemoveALabelFromAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      • name*string

        Name

  • Organizationinteractionrestrictions

    • Show which group of GitHub users can interact with this organization and when the restriction expires

      This action shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.

      GETGetInteractionRestrictionsForAnOrganization

      Request parameters

      • org*string

        Org

    • Temporarily restricts interactions to certain GitHub users in any public repository in the given organization

      This action temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.

      PUTAddOrUpdateInteractionRestrictionsForAnOrganization

      Request parameters

      • org*string

        Org

      Request body

      • limit*string

        Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.

    • Remove all interaction restrictions from public repositories in the given organization

      This action removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

      DELETERemoveInteractionRestrictionsForAnOrganization

      Request parameters

      • org*string

        Org

  • Repositoryinteractionrestrictions

    • getInteractionRestrictionsForARepository

      GETGetInteractionRestrictionsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Temporarily restricts interactions to certain GitHub users within the given repository

      This action temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.

      PUTAddOrUpdateInteractionRestrictionsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • limitstring

        Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.

    • Remove all interaction restrictions from the given repository

      This action removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.

      DELETERemoveInteractionRestrictionsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Members

    • List all users who are members of an organization

      This action list all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

      GETMembersList

      Request parameters

      • org*string

        Org

      • filterstring

        Filter members returned in the list. Can be one of: * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners. * all - All members the authenticated user can see. Default: all

      • rolestring

        Filter members returned by their role. Can be one of: * all - All members of the organization, regardless of role. * admin - Organization owners. * member - Non-owner organization members. Default: all

    • Check if a user is, publicly or privately, a member of the organization

      This action check if a user is, publicly or privately, a member of the organization.

      GETCheckMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • Member of an organization can choose to have their membership publicized or not

      This action members of an organization can choose to have their membership publicized or not.

      GETPublicMembersList

      Request parameters

      • org*string

        Org

    • checkPublicMembership

      GETCheckPublicMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • In order to get a user's membership with an organization, the authenticated user must be an organization member

      This action in order to get a user's membership with an organization, the authenticated user must be an organization member.

      GETGetOrganizationMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • List all teams associated with an invitation

      This action list all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

      GETListOrganizationInvitationTeams

      Request parameters

      • org*string

        Org

      • invitation_id*string

        Invitation_id

    • The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate

      This action the return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

      GETListPendingOrganizationInvitations

      Request parameters

      • org*string

        Org

    • listYourOrganizationMemberships

      GETListYourOrganizationMemberships

      Request parameters

      • statestring

        Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.

    • getYourOrganizationMembership

      GETGetYourOrganizationMembership

      Request parameters

      • org*string

        Org

    • Invite people to an organization by using their GitHub user ID or their email address

      This action invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateOrganizationInvitation

      Request parameters

      • org*string

        Org

      Request body

      • invitee_idinteger

        Required unless you provide email. GitHub user ID for the person you are inviting.

      • emailstring

        Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

      • rolestring

        Specify role for new member. Can be one of: * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization. Default: direct_member.

      • team_idsarray

        Specify IDs for the teams you want to invite new members to.

    • The user can publicize their own membership

      This action the user can publicize their own membership. (A user cannot publicize the membership for another user.)

      PUTPublicizeAUsersMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • Only authenticated organization owners can add a member to the organization or update the member's role

      This action only authenticated organization owners can add a member to the organization or update the member's role.

      PUTAddOrUpdateOrganizationMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

      Request body

      • rolestring

        The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization. Default: member

    • editYourOrganizationMembership

      PATCHEditYourOrganizationMembership

      Request parameters

      • org*string

        Org

      Request body

      • state*string

        The state that the membership should be in. Only "active" will be accepted.

    • Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories

      This action removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

      DELETERemoveAMember

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • concealAUsersMembership

      DELETEConcealAUsersMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • In order to remove a user's membership with an organization, the authenticated user must be an organization owner

      This action in order to remove a user's membership with an organization, the authenticated user must be an organization owner.

      DELETERemoveOrganizationMembership

      Request parameters

      • org*string

        Org

      • username*string

        Username

  • TeamMembers

    • Team members will include the members of child teams

      This action team members will include the members of child teams. To list members in a team, the team must be visible to the authenticated user.

      GETListTeamMembers

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • rolestring

        Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team. Default: all

    • Team members will include the members of child teams

      This action team members will include the members of child teams. To get a user's membership with a team, the team must be visible to the authenticated user.

      GETGetTeamMembership

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • username*string

        Username

    • The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate

      This action the return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub member, the login field in the return hash will be null.

      GETListPendingTeamInvitations

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • Add an organization member to a team

      This action adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

      PUTAddOrUpdateTeamMembership

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • username*string

        Username

      Request body

      • rolestring

        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

    • To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with

      This action to remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

      DELETERemoveTeamMembership

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • username*string

        Username

  • Teams

    • List all teams in an organization that are visible to the authenticated user

      This action lists all teams in an organization that are visible to the authenticated user.

      GETListTeams

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • org*string

        Org

    • getTeamByName

      GETGetTeamByName

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • List the child teams of the team requested by :team_slug

      This action lists the child teams of the team requested by :team_slug.

      GETListChildTeams

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • List a team's repositories visible to the authenticated user

      This action lists a team's repositories visible to the authenticated user.

      GETListTeamRepos

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • Check whether a team has admin, push, or pull permission for a repository

      This action checks whether a team has admin, push, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

      GETCheckIfATeamManagesARepository

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • owner*string

        Owner

      • repo*string

        Repo

    • List all of the teams across all of the organizations to which the authenticated user belongs

      This action list all of the teams across all of the organizations to which the authenticated user belongs. This method requires user, repo, or read:org scope when authenticating via OAuth.

      GETListUserTeams
    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Lists the organization projects for a team.

      GETListTeamProjects

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

      GETReviewATeamProject

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • project_id*string

        Project_id

    • To create a team, the authenticated user must be a member or owner of :org

      This action to create a team, the authenticated user must be a member or owner of :org. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "Setting team creation permissions." When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see "About teams" in the GitHub Help documentation.

      POSTCreateTeam

      Request parameters

      • org*string

        Org

      Request body

      • name*string

        The name of the team.

      • descriptionstring

        The description of the team.

      • maintainersarray

        List GitHub IDs for organization members who will become team maintainers.

      • repo_namesarray

        The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

      • privacystring

        The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed

      • parent_team_idinteger

        The ID of a team to set as the parent team.

    • To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team

      This action to add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

      PUTAddOrUpdateTeamRepository

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • permissionstring

        The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to 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. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

      PUTAddOrUpdateTeamProject

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • project_id*string

        Project_id

      Request body

      • permissionstring

        The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project.

    • To edit a team, the authenticated user must either be an organization owner or a team maintainer

      This action to edit a team, the authenticated user must either be an organization owner or a team maintainer.

      PATCHEditTeam

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      Request body

      • name*string

        The name of the team.

      • descriptionstring

        The description of the team.

      • privacystring

        The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

      • parent_team_idinteger

        The ID of a team to set as the parent team.

    • To delete a team, the authenticated user must be an organization owner or team maintainer

      This action to delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well.

      DELETEDeleteTeam

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team

      This action if the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

      DELETERemoveTeamRepository

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • owner*string

        Owner

      • repo*string

        Repo

    • Remove an organization project from a team

      This action removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

      DELETERemoveTeamProject

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • project_id*string

        Project_id

  • Installations

    • listRepositories

      GETListRepositories
    • List installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access

      This action lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.

      GETListInstallationsForAUser
    • List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation

      This action list repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.

      GETListRepositoriesAccessibleToTheUserForAnInstallation

      Request parameters

      • installation_id*string

        Installation_id

    • Create an attachment under a content reference URL in the body or comment of an issue or pull request

      This action creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the id of the content reference from the content_reference event to create an attachment.

      POSTCreateAContentAttachment

      Request parameters

      • content_reference_id*string

        Content_reference_id

      Request body

      • title*string

        The title of the content attachment displayed in the body or comment of an issue or pull request.

      • body*string

        The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.

    • Add a single repository to an installation

      This action add a single repository to an installation. The authenticated user must have admin access to the repository.

      PUTAddRepositoryToInstallation

      Request parameters

      • installation_id*string

        Installation_id

      • repository_id*string

        Repository_id

    • Remove a single repository from an installation

      This action remove a single repository from an installation. The authenticated user must have admin access to the repository.

      DELETERemoveRepositoryFromInstallation

      Request parameters

      • installation_id*string

        Installation_id

      • repository_id*string

        Repository_id

    • Revoke the installation token you're using to authenticate as an installation and access this endpoint

      This action revokes the installation token you're using to authenticate as an installation and access this endpoint.

      DELETERevokeAnInstallationToken
  • Projectcollaborators

    • List the collaborators for an organization project

      This action lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

      GETListCollaborators

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • project_id*string

        Project_id

      • affiliationstring

        Filters the collaborators by their affiliation. Can be one of: * outside: Outside collaborators of a project that are not a member of the project's organization. * direct: Collaborators with permissions to a project, regardless of organization membership status. * all: All collaborators the authenticated user can see. Default: all

    • Return the collaborator's permission level for an organization project

      This action returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

      GETReviewAUsersPermissionLevel

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • username*string

        Username

      • project_id*string

        Project_id

    • Add a collaborator to a an organization project and sets their permission level

      This action adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

      PUTAddUserAsACollaborator

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • username*string

        Username

      • project_id*string

        Project_id

      Request body

      • permissionstring

        The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Can be one of: * read - can read, but not write to or administer this project. * write - can read and write, but not administer this project. * admin - can read, write and administer this project. Default: write

    • Remove a collaborator from an organization project

      This action removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

      DELETERemoveUserAsACollaborator

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • username*string

        Username

      • project_id*string

        Project_id

  • BlockAnotherUser

    • checkWhetherYouveBlockedAUser

      GETCheckWhetherYouveBlockedAUser

      Request parameters

      • username*string

        Username

    • List the users you've blocked on your personal account

      This action list the users you've blocked on your personal account.

      GETListBlockedUsers

      Request parameters

      • org*string

        Org

    • blockAUser

      PUTBlockAUser

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • unblockAUser

      DELETEUnblockAUser

      Request parameters

      • org*string

        Org

      • username*string

        Username

  • SourceImports

    • View the progress of an import

      This action view the progress of an import.

      GETGetImportProgress

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Each type of source control system represents authors in a different way

      This action each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot . This API method and the "Map a commit author" method allow you to provide correct Git author information.

      GETGetCommitAuthors

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • sincestring

        Only 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.

    • List files larger than 100MB found during the import

      This action list files larger than 100MB found during the import

      GETGetLargeFiles

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Start a source import to a GitHub repository using GitHub Importer

      This action start a source import to a GitHub repository using GitHub Importer.

      PUTStartAnImport

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • vcs_url*string

        The URL of the originating repository.

      • vcsstring

        The 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.

      • vcs_usernamestring

        If authentication is required, the username to provide to vcs_url.

      • vcs_passwordstring

        If authentication is required, the password to provide to vcs_url.

      • tfvc_projectstring

        For a tfvc import, the name of the project that is being imported.

    • An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request

      This action an import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.

      PATCHUpdateExistingImport

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • vcs_usernamestring

        The username to provide to the originating repository.

      • vcs_passwordstring

        The password to provide to the originating repository.

    • Update an author's identity for the import

      This action update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.

      PATCHMapACommitAuthor

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • author_id*string

        Author_id

      Request body

      • emailstring

        The new Git author email.

      • namestring

        The new Git author name.

    • You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB

      This action you can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by Git LFS. You can learn more about our LFS feature and working with large files on our help site.

      PATCHSetGitLFSPreference

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • use_lfs*string

        Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).

    • Stop an import for a repository

      This action stop an import for a repository.

      DELETECancelAnImport

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Workflowruns

    • List all workflow runs for a workflow

      This action list all workflow runs for a workflow. You can also replace :workflow_id with :workflow_file_name. For example, you could use main.yml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters. Anyone with read access to the repository can use this endpoint.

      GETListWorkflowRuns

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • workflow_id*string

        Workflow_id

      • actorstring

        Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

      • branchstring

        Returns workflow runs associated with a branch. Use the name of the branch of the push.

      • eventstring

        Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

      • statusstring

        Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

    • List all workflow runs for a repository

      This action lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETListRepositoryWorkflowRuns

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • actorstring

        Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

      • branchstring

        Returns workflow runs associated with a branch. Use the name of the branch of the push.

      • eventstring

        Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

      • statusstring

        Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

    • Get a specific workflow run

      This action gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETGetAWorkflowRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • run_id*string

        Run_id

    • Get a redirect URL to download an archive of log files for a workflow run

      This action gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETListWorkflowRunLogs

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • run_id*string

        Run_id

    • Re-run your workflow run using its id

      This action re-runs your workflow run using its id. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      POSTReRunAWorkflow

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • run_id*string

        Run_id

    • Cancel a workflow run using its id

      This action cancels a workflow run using its id. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      POSTCancelAWorkflowRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • run_id*string

        Run_id

  • Gists

    • listPublicGistsForTheSpecifiedUser

      GETListPublicGistsForTheSpecifiedUser

      Request parameters

      • username*string

        Username

      • sincestring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    • listTheAuthenticatedUsersGists

      GETListTheAuthenticatedUsersGists

      Request parameters

      • sincestring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    • List all public gists sorted by most recently updated to least recently updated

      This action list all public gists sorted by most recently updated to least recently updated.

      GETListAllPublicGists

      Request parameters

      • sincestring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    • List the authenticated user's starred gists

      This action list the authenticated user's starred gists

      GETListStarredGists

      Request parameters

      • sincestring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

    • getASingleGist

      GETGetASingleGist

      Request parameters

      • gist_id*string

        Gist_id

    • getASpecificRevisionOfAGist

      GETGetASpecificRevisionOfAGist

      Request parameters

      • gist_id*string

        Gist_id

      • sha*string

        Sha

    • listGistCommits

      GETListGistCommits

      Request parameters

      • gist_id*string

        Gist_id

    • checkIfAGistIsStarred

      GETCheckIfAGistIsStarred

      Request parameters

      • gist_id*string

        Gist_id

    • listGistForks

      GETListGistForks

      Request parameters

      • gist_id*string

        Gist_id

    • Allow you to add a new gist with one or more files

      This action allows you to add a new gist with one or more files.

      POSTCreateAGist

      Request body

      • files*string

        Required. The filenames and content of each file in the gist. The keys in the files object represent the filename and have the type string.

      • descriptionstring

        A descriptive name for this gist.

      • publicboolean

        When true, the gist will be public and available for anyone to see. Default: false

    • forkAGist

      POSTForkAGist

      Request parameters

      • gist_id*string

        Gist_id

    • starAGist

      PUTStarAGist

      Request parameters

      • gist_id*string

        Gist_id

    • Allow you to update or delete a gist file and rename gist files

      This action allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

      PATCHEditAGist

      Request parameters

      • gist_id*string

        Gist_id

      Request body

      • descriptionstring

        A descriptive name for this gist.

      • filesstring

        The filenames and content that make up this gist.

    • unstarAGist

      DELETEUnstarAGist

      Request parameters

      • gist_id*string

        Gist_id

    • deleteAGist

      DELETEDeleteAGist

      Request parameters

      • gist_id*string

        Gist_id

  • GitHubMarketplace

    • listAllPlansForYourMarketplaceListing

      GETListAllPlansForYourMarketplaceListing
    • Return any accounts associated with a plan, including free plans

      This action returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

      GETListAllGitHubAccountsUserOrOrganizationOnASpecificPlan

      Request parameters

      • plan_id*string

        Plan_id

      • sortstring

        Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated. Default: created

      • directionstring

        To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

    • Show whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App

      This action shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

      GETCheckIfAGitHubAccountIsAssociatedWithAnyMarketplaceListing

      Request parameters

      • account_id*string

        Account_id

    • Return only active subscriptions

      This action returns only active subscriptions. You must use a user-to-server OAuth access token, created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an OAuth token.

      GETGetAUsersMarketplacePurchases
  • Collaborators

    • For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners

      This action for organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. Team members will include the members of child teams.

      GETCheckIfAUserIsACollaborator

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • username*string

        Username

  • Followers

    • listAUsersFollowers

      GETListAUsersFollowers

      Request parameters

      • username*string

        Username

    • listTheAuthenticatedUsersFollowers

      GETListTheAuthenticatedUsersFollowers
    • listWhoAUserIsFollowing

      GETListWhoAUserIsFollowing

      Request parameters

      • username*string

        Username

    • listWhoTheAuthenticatedUserIsFollowing

      GETListWhoTheAuthenticatedUserIsFollowing
    • checkIfYouAreFollowingAUser

      GETCheckIfYouAreFollowingAUser

      Request parameters

      • username*string

        Username

    • checkIfOneUserFollowsAnother

      GETCheckIfOneUserFollowsAnother

      Request parameters

      • username*string

        Username

      • target_user*string

        Target_user

    • followAUser

      PUTFollowAUser

      Request parameters

      • username*string

        Username

    • unfollowAUser

      DELETEUnfollowAUser

      Request parameters

      • username*string

        Username

  • Repositories

    • List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access

      This action lists repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

      GETListYourRepositories

      Request parameters

      • visibilitystring

        Can be one of all, public, or private. Default: all

      • affiliationstring

        Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. Default: owner,collaborator,organization_member

      • typestring

        Can be one of all, owner, public, private, member. Default: all. Will cause a 422 error if used in the same request as visibility or affiliation.

      • sortstring

        Can be one of created, updated, pushed, full_name. Default: full_name

      • directionstring

        Can be one of asc or desc. Default: asc when using full_name, otherwise desc

    • List public repositories for the specified user

      This action lists public repositories for the specified user.

      GETListUserRepositories

      Request parameters

      • username*string

        Username

      • typestring

        Can be one of all, owner, member. Default: owner

      • sortstring

        Can be one of created, updated, pushed, full_name. Default: full_name

      • directionstring

        Can be one of asc or desc. Default: asc when using full_name, otherwise desc

    • List repositories for the specified organization

      This action lists repositories for the specified organization.

      GETListOrganizationRepositories

      Request parameters

      • org*string

        Org

      • typestring

        Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, type can also be internal.

      • sortstring

        Can be one of created, updated, pushed, full_name. Default: created

      • directionstring

        Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

    • List all public repositories in the order that they were created

      This action lists all public repositories in the order that they were created. Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.

      GETListAllPublicRepositories

      Request parameters

      • sinceinteger

        The integer ID of the last repository that you've seen.

    • get

      GETGet

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listAllTopicsForARepository

      GETListAllTopicsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Show whether vulnerability alerts are enabled or disabled for a repository

      This action shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

      GETCheckIfVulnerabilityAlertsAreEnabledForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • List contributors to the specified repository and sorts them by the number of commits per contributor in descending order

      This action lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.

      GETListContributors

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • anonstring

        Set to 1 or true to include anonymous contributors in results.

    • List languages for the specified repository

      This action lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

      GETListLanguages

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listTags

      GETListTags

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • createsANewRepositoryForTheAuthenticatedUser

      POSTCreatesANewRepositoryForTheAuthenticatedUser

      Request body

      • name*string

        The name of the repository.

      • descriptionstring

        A short description of the repository.

      • homepagestring

        A URL with more information about the repository.

      • privateboolean

        Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false

      • visibilitystring

        Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

      • has_issuesboolean

        Either true to enable issues for this repository or false to disable them. Default: true.

      • has_projectsboolean

        Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

      • has_wikiboolean

        Either true to enable the wiki for this repository or false to disable it. Default: true.

      • is_templateboolean

        Either true to make this repo available as a template repository or false to prevent it. Default: false.

      • team_idinteger

        The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

      • auto_initboolean

        Pass true to create an initial commit with empty README. Default: false.

      • itignore_templatestring

        Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

      • license_templatestring

        Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

      • allow_squash_mergeboolean

        Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true

      • allow_merge_commitboolean

        Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true

      • allow_rebase_mergeboolean

        Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true.

      • delete_branch_on_mergeboolean

        Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. Default: false.

    • The authenticated user must be a member of the organization

      This action the authenticated user must be a member of the organization.

      POSTCreatesANewRepositoryInTheSpecifiedOrganization

      Request parameters

      • org*string

        Org

      Request body

      • name*string

        The name of the repository.

      • descriptionstring

        A short description of the repository.

      • homepagestring

        A URL with more information about the repository.

      • privateboolean

        Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account. Default: false

      • visibilitystring

        Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

      • has_issuesboolean

        Either true to enable issues for this repository or false to disable them. Default: true.

      • has_projectsboolean

        Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

      • has_wikiboolean

        Either true to enable the wiki for this repository or false to disable it. Default: true.

      • is_templateboolean

        Either true to make this repo available as a template repository or false to prevent it. Default: false.

      • team_idinteger

        The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

      • auto_initboolean

        Pass true to create an initial commit with empty README. Default: false.

      • itignore_templatestring

        Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

      • license_templatestring

        Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

      • allow_squash_mergeboolean

        Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true

      • allow_merge_commitboolean

        Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true

      • allow_rebase_mergeboolean

        Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true.

      • delete_branch_on_mergeboolean

        Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. Default: false.

    • Create a new repository using a repository template

      This action creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the GET /repos/:owner/:repo endpoint and check that the is_template key is true.

      POSTCreateRepositoryUsingARepositoryTemplate

      Request parameters

      • template_owner*string

        Template_owner

      • template_repo*string

        Template_repo

      Request body

      • name*string

        The name of the new repository.

      • ownerstring

        The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

      • descriptionstring

        A short description of the new repository.

      • privateboolean

        Either true to create a new private repository or false to create a new public one. Default: false

    • A transfer request will need to be accepted by the new owner when transferring a personal repository to another user

      This action a transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

      POSTTransferARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • new_owner*string

        The username or organization name the repository will be transferred to.

      • team_idsarray

        ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

    • You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook

      This action you can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see "RepositoryDispatchEvent."

      POSTCreateARepositoryDispatchEvent

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • event_type*string

        A custom webhook event name.

      • client_payloadstring

        JSON payload with extra information about the webhook event that your action or worklow may use. Default: {}

    • replaceAllTopicsForARepository

      PUTReplaceAllTopicsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • names*array

        An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

    • Enable vulnerability alerts and the dependency graph for a repository

      This action enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

      PUTEnableVulnerabilityAlerts

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Enable automated security fixes for a repository

      This action enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes" in the GitHub Help documentation.

      PUTEnableAutomatedSecurityFixes

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • edit

      PATCHEdit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • namestring

        The name of the repository.

      • descriptionstring

        A short description of the repository.

      • homepagestring

        A URL with more information about the repository.

      • privateboolean

        Either true to make the repository private or false to make it public. Creating private repositories requires a paid GitHub account. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

      • visibilitystring

        Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

      • has_issuesboolean

        Either true to enable issues for this repository or false to disable them. Default: true.

      • has_projectsboolean

        Either true to enable projects for this repository or false to disable them. Default: true. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

      • has_wikiboolean

        Either true to enable the wiki for this repository or false to disable it. Default: true.

      • is_templateboolean

        Either true to make this repo available as a template repository or false to prevent it. Default: false.

      • default_branchstring

        Updates the default branch for this repository.

      • allow_squash_mergeboolean

        Either true to allow squash-merging pull requests, or false to prevent squash-merging. Default: true

      • allow_merge_commitboolean

        Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits. Default: true

      • allow_rebase_mergeboolean

        Either true to allow rebase-merging pull requests, or false to prevent rebase-merging. Default: true.

      • delete_branch_on_mergeboolean

        Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion. Default: false

      • archivedboolean

        true to archive this repository. Note: You cannot unarchive repositories through the API. Default: false

    • Disable vulnerability alerts and the dependency graph for a repository

      This action disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "About security alerts for vulnerable dependencies" in the GitHub Help documentation.

      DELETEDisableVulnerabilityAlerts

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Disable automated security fixes for a repository

      This action disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring automated security fixes" in the GitHub Help documentation.

      DELETEDisableAutomatedSecurityFixes

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Deleting a repository requires admin access

      This action deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

      DELETEDeleteARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Starring

    • listStargazers

      GETListStargazers

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listRepositoriesBeingStarredByAUser.

      GETListRepositoriesBeingStarredByAUser

      Request parameters

      • username*string

        Username

      • sortstring

        One of created (when the repository was starred) or updated (when it was last pushed to). Default: created

      • directionstring

        One of asc (ascending) or desc (descending). Default: desc

    • listRepositoriesBeingStarredByTheAuthenticatedUser.

      GETListRepositoriesBeingStarredByTheAuthenticatedUser

      Request parameters

      • sortstring

        One of created (when the repository was starred) or updated (when it was last pushed to). Default: created

      • directionstring

        One of asc (ascending) or desc (descending). Default: desc

    • Require for the user to be authenticated

      This action requires for the user to be authenticated.

      GETCheckIfYouAreStarringARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Require for the user to be authenticated

      This action requires for the user to be authenticated.

      PUTStarARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Require for the user to be authenticated

      This action requires for the user to be authenticated.

      DELETEUnstarARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Watching

    • listWatchers

      GETListWatchers

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listRepositoriesBeingWatchedByAUser

      GETListRepositoriesBeingWatchedByAUser

      Request parameters

      • username*string

        Username

    • listRepositoriesBeingWatchedByTheAuthenticatedUser

      GETListRepositoriesBeingWatchedByTheAuthenticatedUser
    • getARepositorySubscription

      GETGetARepositorySubscription

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Require for the user to be authenticated

      This action requires for the user to be authenticated.

      GETCheckIfYouAreWatchingARepositoryLEGACY

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • setARepositorySubscription

      PUTSetARepositorySubscription

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • subscribedboolean

        Determines if notifications should be received from this repository.

      • ignoredboolean

        Determines if all notifications should be blocked from this repository.

    • Require the user to be authenticated

      This action requires the user to be authenticated.

      PUTWatchARepositoryLEGACY

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • deleteARepositorySubscription

      DELETEDeleteARepositorySubscription

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Require for the user to be authenticated

      This action requires for the user to be authenticated.

      DELETEStopWatchingARepositoryLEGACY

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • BlockingOrganizationsUsers

    • checkWhetherAUserIsBlockedFromAnOrganization

      GETCheckWhetherAUserIsBlockedFromAnOrganization

      Request parameters

      • org*string

        Org

      • username*string

        Username

  • Traffic

    • Get the top 10 referrers over the last 14 days

      This action get the top 10 referrers over the last 14 days.

      GETListReferrers

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

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

      This action get the top 10 popular contents over the last 14 days.

      GETListPaths

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

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

      This action get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

      GETViews

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • perstring

        Must be one of: day, week. Default: day

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

      This action get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.

      GETClones

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • perstring

        Must be one of: day, week. Default: day

  • Commits

    • listCommitsOnARepository

      GETListCommitsOnARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • shastring

        SHA or branch to start listing commits from. Default: the repository's default branch (usually master).

      • pathstring

        Only commits containing this file path will be returned.

      • authorstring

        GitHub login or email address by which to filter by commit author.

      • sincestring

        Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • untilstring

        Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • Return the contents of a single commit reference

      This action returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

      GETGetASingleCommit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

    • Both :base and :head must be branch names in :repo

      This action both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format :branch.

      GETCompareTwoCommits

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • base*string

        Base

      • head*string

        Head

    • Return all branches where the given commit SHA is the HEAD, or latest commit for the branch

      This action returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. The API may change without advance notice during the preview period.

      GETListBranchesForHEADCommit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • commit_sha*string

        Commit_sha

    • List all pull requests containing the provided commit SHA, which can be from any point in the commit history

      This action lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The API may change without advance notice during the preview period.

      GETListPullRequestsAssociatedWithCommit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • commit_sha*string

        Commit_sha

  • OutsideCollaborators

    • List all users who are outside collaborators of an organization

      This action list all users who are outside collaborators of an organization.

      GETListOutsideCollaborators

      Request parameters

      • org*string

        Org

      • filterstring

        Filter the list of outside collaborators. Can be one of: * 2fa_disabled: Outside collaborators without two-factor authentication enabled. * all: All outside collaborators. Default: all

    • When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows

      This action when an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator".

      PUTConvertMemberToOutsideCollaborator

      Request parameters

      • org*string

        Org

      • username*string

        Username

    • Removing a user from this list will remove them from all the organization's repositories

      This action removing a user from this list will remove them from all the organization's repositories.

      DELETERemoveOutsideCollaborator

      Request parameters

      • org*string

        Org

      • username*string

        Username

  • GitBlobs

    • getABlob

      GETGetABlob

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • file_sha*string

        File_sha

    • createABlob

      POSTCreateABlob

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • content*string

        The new blob's content.

      • encodingstring

        The encoding used for content. Currently, "utf-8" and "base64" are supported. Default: "utf-8".

  • CheckRuns

    • List check runs for a commit ref

      This action lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

      GETListCheckRunsForASpecificRef

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

      • check_namestring

        Returns check runs with the specified name.

      • statusstring

        Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

      • filterstring

        Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all. Default: latest

    • List check runs for a check suite using its id

      This action lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

      GETListCheckRunsInACheckSuite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • check_suite_id*string

        Check_suite_id

      • check_namestring

        Returns check runs with the specified name.

      • statusstring

        Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

      • filterstring

        Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all. Default: latest

    • Get a single check run using its id

      This action gets a single check run using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

      GETGetASingleCheckRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • check_run_id*string

        Check_run_id

    • List annotations for a check run using the annotation id

      This action lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

      GETListAnnotationsForACheckRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • check_run_id*string

        Check_run_id

    • Create a new check run for a specific commit in a repository

      This action creates a new check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to create check runs.

      POSTCreateACheckRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • name*string

        The name of the check. For example, "code-coverage".

      • head_sha*string

        The SHA of the commit.

      • details_urlstring

        The URL of the integrator's site that has the full details of the check.

      • external_idstring

        A reference for the run on the integrator's system.

      • statusstring

        The current status. Can be one of queued, in_progress, or completed. Default: queued

      • started_atstring

        The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • conclusionstring

        Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.

      • completed_atstring

        The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • outputobject

        Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

      • actionsarray

        Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions."

    • Update a check run for a specific commit in a repository

      This action updates a check run for a specific commit in a repository. Your GitHub App must have the checks:write permission to edit check runs.

      PATCHUpdateACheckRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • check_run_id*string

        Check_run_id

      Request body

      • namestring

        The name of the check. For example, "code-coverage".

      • details_urlstring

        The URL of the integrator's site that has the full details of the check.

      • external_idstring

        A reference for the run on the integrator's system.

      • started_atstring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • statusstring

        The current status. Can be one of queued, in_progress, or completed.

      • conclusionstring

        Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.

      • completed_atstring

        The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • outputobject

        Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

      • actionsarray

        Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description.

  • CheckSuites

    • Get a single check suite using its id

      This action gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

      GETGetASingleCheckSuite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • check_suite_id*string

        Check_suite_id

    • List check suites for a commit ref

      This action lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

      GETListCheckSuitesForASpecificRef

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

      • app_idinteger

        Filters check suites by GitHub App id.

      • check_namestring

        Filters checks suites by the name of the check run.

    • By default, check suites are automatically created when you create a check run

      This action by default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "Set preferences for check suites on a repository". Your GitHub App must have the checks:write permission to create check suites.

      POSTCreateACheckSuite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • head_sha*string

        The sha of the head commit.

    • Trigger GitHub to rerequest an existing check suite, without pushing new code to a repository

      This action triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared. To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

      POSTRerequestCheckSuite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • check_suite_id*string

        Check_suite_id

    • Change the default automatic flow when creating check suites

      This action changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

      PATCHSetPreferencesForCheckSuitesOnARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • auto_trigger_checksarray

        Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

  • TeamDiscussionComments

    • List all comments on a team discussion

      This action list all comments on a team discussion.

      GETListComments

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • directionstring

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc. Default: desc

    • getASingleComment

      GETGetASingleComment

      Request parameters

      • gist_id*string

        Gist_id

      • comment_id*string

        Comment_id

      • owner*string

        Owner

      • repo*string

        Repo

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • comment_number*string

        Comment_number

    • Create a new comment on a team discussion

      This action creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateAComment

      Request parameters

      • gist_id*string

        Gist_id

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      • pull_number*string

        Pull_number

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      Request body

      • body*string

        The discussion comment's body text.

      • commit_id*string

        The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

      • path*string

        The relative path to the file that necessitates a comment.

      • positioninteger

        Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

      • sidestring

        Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

      • lineinteger

        Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

      • start_lineinteger

        Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

      • start_sidestring

        Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

    • Edit the body text of a discussion comment

      This action edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

      PATCHEditAComment

      Request parameters

      • gist_id*string

        Gist_id

      • comment_id*string

        Comment_id

      • owner*string

        Owner

      • repo*string

        Repo

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • comment_number*string

        Comment_number

      Request body

      • body*string

        The discussion comment's body text.

    • Delete a comment on a team discussion

      This action deletes a comment on a team discussion.

      DELETEDeleteAComment

      Request parameters

      • gist_id*string

        Gist_id

      • comment_id*string

        Comment_id

      • owner*string

        Owner

      • repo*string

        Repo

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • comment_number*string

        Comment_number

  • GitCommits

    • Get a Git commit object

      This action gets a Git commit object.

      GETGetACommit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • commit_sha*string

        Commit_sha

    • Create a new Git commit object

      This action creates a new Git commit object.

      POSTCreateACommit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • message*string

        The commit message

      • tree*string

        The SHA of the tree object this commit points to

      • parents*array

        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.

      • authorobject

        Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

      • committerobject

        Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

      • signaturestring

        The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

  • ReposComments

    • Commit Comments use these custom media types

      This action commit Comments use these custom media types. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).

      GETListCommitCommentsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Use the :commit_sha to specify the commit that will have its comments listed

      This action use the :commit_sha to specify the commit that will have its comments listed.

      GETListCommentsForASingleCommit

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • commit_sha*string

        Commit_sha

    • getASingleCommitComment

      GETGetASingleCommitComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

    • Create a comment for a commit using its :commit_sha

      This action create a comment for a commit using its :commit_sha. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateACommitComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • commit_sha*string

        Commit_sha

      Request body

      • bodystring

        The contents of the comment.

      • pathstring

        Relative path of the file to comment on.

      • positioninteger

        Line index in the diff to comment on.

    • updateACommitComment

      PATCHUpdateACommitComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      Request body

      • body*string

        The contents of the comment

    • deleteACommitComment

      DELETEDeleteACommitComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

  • Deployments

    • Simple filtering of deployments is available via query parameters

      This action simple filtering of deployments is available via query parameters

      GETListDeployments

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • shastring

        The SHA recorded at creation time. Default: none

      • refstring

        The name of the ref. This can be a branch, tag, or SHA. Default: none

      • taskstring

        The name of the task for the deployment (e.g., deploy or deploy:migrations). Default: none

      • environmentstring

        The name of the environment that was deployed to (e.g., staging or production). Default: none

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.

      GETGetASingleDeployment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • deployment_id*string

        Deployment_id

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Users with pull access can view deployment statuses for a deployment

      GETListDeploymentStatuses

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • deployment_id*string

        Deployment_id

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Users with pull access can view a deployment status for a deployment

      GETGetASingleDeploymentStatus

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • deployment_id*string

        Deployment_id

      • status_id*string

        Status_id

    • Deployment offer a few configurable parameters with sane defaults

      This action deployments offer a few configurable parameters with sane defaults. The ref parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request. The environment parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as production, staging, and qa. This parameter makes it easier to track which environments have requested deployments. The default environment is production. The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response. By default, commit statuses for every submitted context must be in a success state. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed. The payload parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched. The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. Users with repo or repo_deployment scopes can create a deployment for a given ref

      POSTCreateADeployment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • ref*string

        The ref to deploy. This can be a branch, tag, or SHA.

      • taskstring

        Specifies a task to execute (e.g., deploy or deploy:migrations). Default: deploy

      • auto_mergeboolean

        Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. Default: true

      • required_contextsarray

        The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

      • payloadstring

        JSON payload with extra information about the deployment. Default: ""

      • environmentstring

        Name for the target deployment environment (e.g., production, staging, qa). Default: production

      • descriptionstring

        Short description of the deployment. Default: ""

      • transient_environmentboolean

        Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

      • production_environmentboolean

        Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Users with push access can create deployment statuses for a given deployment. GitHub Apps require read & write access to "Deployments" and read-only access to "Repo contents" (for private repos). OAuth Apps require the repo_deployment scope.

      POSTCreateADeploymentStatus

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • deployment_id*string

        Deployment_id

      Request body

      • state*string

        The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type.

      • target_urlstring

        The 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: "" Note: It's recommended to use the log_url parameter, which replaces target_url.

      • log_urlstring

        The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "". Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

      • descriptionstring

        A short description of the status. The maximum description length is 140 characters. Default: ""

      • environmentstring

        Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

      • environment_urlstring

        Sets the URL for accessing your environment. Default: "". Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

      • auto_inactiveboolean

        Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true. Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • TeamDiscussions

    • listDiscussions

      GETListDiscussions

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • directionstring

        Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc. Default: desc

    • getASingleDiscussion

      GETGetASingleDiscussion

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

    • Create a new discussion post on a team's page

      This action creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateADiscussion

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      Request body

      • title*string

        The discussion post's title.

      • body*string

        The discussion post's body text.

      • privateboolean

        Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post. Default: false

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support. Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

      PATCHEditADiscussion

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      Request body

      • titlestring

        The discussion post's title.

      • bodystring

        The discussion post's body text.

    • Delete a discussion from a team's page

      This action delete a discussion from a team's page.

      DELETEDeleteADiscussion

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

  • Forks

    • listForks

      GETListForks

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • sortstring

        The sort order. Can be either newest, oldest, or stargazers. Default: newest

    • Create a fork for the authenticated user

      This action create a fork for the authenticated user.

      POSTCreateAFork

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • organizationstring

        Optional parameter to specify the organization name if forking into an organization.

  • GitHubApps

    • If the GitHub App you specify is public, you can access this endpoint without authenticating

      This action if the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

      GETGetASingleGitHubApp

      Request parameters

      • app_slug*string

        App_slug

    • Return the GitHub App associated with the authentication credentials used

      This action returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the "List installations" endpoint.

      GETGetTheAuthenticatedGitHubApp
    • You must use a [JWT](https://developer

      This action you must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      GETListInstallations
    • You must use a [JWT](https://developer

      This action you must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      GETGetAnInstallation

      Request parameters

      • installation_id*string

        Installation_id

    • Enable an authenticated GitHub App to find the organization's installation information

      This action enables an authenticated GitHub App to find the organization's installation information. You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      GETGetAnOrganizationInstallation

      Request parameters

      • org*string

        Org

    • Enable an authenticated GitHub App to find the repository's installation information

      This action enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      GETGetARepositoryInstallation

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Enable an authenticated GitHub App to find the user's installation information

      This action enables an authenticated GitHub App to find the user's installation information. You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      GETGetAUserInstallation

      Request parameters

      • username*string

        Username

    • Create an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account

      This action creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain the repositories key. You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      POSTCreateANewInstallationToken

      Request parameters

      • installation_id*string

        Installation_id

      Request body

      • repository_idsarray

        The ids of the repositories that the installation token can access. Providing repository ids restricts the access of an installation token to specific repositories. You can use the "List repositories" endpoint to get the id of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.

      • permissionsstring

        The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see ["GitHub App permissions."](https://developer.github.com/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions)

    • Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow

      This action use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

      POSTCreateAGitHubAppFromAManifest

      Request parameters

      • code*string

        Code

    • Uninstall a GitHub App on a user, organization, or business account

      This action uninstalls a GitHub App on a user, organization, or business account. You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

      DELETEDeleteAnInstallation

      Request parameters

      • installation_id*string

        Installation_id

  • GPGKeys

    • List the GPG keys for a user

      This action lists the GPG keys for a user. This information is accessible by anyone.

      GETListGPGKeysForAUser

      Request parameters

      • username*string

        Username

    • List the current user's GPG keys

      This action lists the current user's GPG keys.

      GETListYourGPGKeys
    • View extended details for a single GPG key

      This action view extended details for a single GPG key.

      GETGetASingleGPGKey

      Request parameters

      • gpg_key_id*string

        Gpg_key_id

    • Add a GPG key to the authenticated user's GitHub account

      This action adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.

      POSTCreateAGPGKey

      Request body

      • armored_public_keystring

        Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

    • Remove a GPG key from the authenticated user's GitHub account

      This action removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.

      DELETEDeleteAGPGKey

      Request parameters

      • gpg_key_id*string

        Gpg_key_id

  • ReposWebhooks

    • listHooks

      GETListHooks

      Request parameters

      • org*string

        Org

      • owner*string

        Owner

      • repo*string

        Repo

    • getSingleHook

      GETGetSingleHook

      Request parameters

      • org*string

        Org

      • hook_id*string

        Hook_id

      • owner*string

        Owner

      • repo*string

        Repo

    • Repository can have multiple webhooks installed

      This action repositories can have multiple webhooks installed. Each webhook should have a unique config. Multiple webhooks can share the same config as long as those webhooks do not have any events that overlap.

      POSTCreateAHook

      Request parameters

      • org*string

        Org

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • config*object

        Key/value pairs to provide settings for this webhook. These are defined below.

      • namestring

        Use web to create a webhook. Default: web. This parameter only accepts the value web.

      • eventsarray

        Determines what events the hook is triggered for. Default: ["push"]

      • activeboolean

        Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. Default: true.

    • This will trigger a ping event to be sent to the hook

      This action this will trigger a ping event to be sent to the hook.

      POSTPingAHook

      Request parameters

      • org*string

        Org

      • hook_id*string

        Hook_id

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • name*string

        Must be passed as "web".

      • config*object

        Key/value pairs to provide settings for this webhook. These are defined below.

      • eventsarray

        Determines what events the hook is triggered for. Default: ["push"].

      • activeboolean

        Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. Default: true.

    • This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events

      This action this will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook is not subscribed to push events, the server will respond with 204 but no test POST will be generated.

      POSTTestAPushHook

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • hook_id*string

        Hook_id

    • editAHook

      PATCHEditAHook

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • hook_id*string

        Hook_id

      Request body

      • configobject

        Key/value pairs to provide settings for this webhook.

      • eventsarray

        Determines what events the hook is triggered for. This replaces the entire array of events. Default: ["push"]

      • add_eventsarray

        Determines a list of events to be added to the list of events that the Hook triggers for.

      • remove_eventsarray

        Determines a list of events to be removed from the list of events that the Hook triggers for.

      • activeboolean

        Determines if notifications are sent when the webhook is triggered. Set to true to send notifications. Default: true.

    • deleteAHook

      DELETEDeleteAHook

      Request parameters

      • org*string

        Org

      • hook_id*string

        Hook_id

      • owner*string

        Owner

      • repo*string

        Repo

  • Milestones

    • listMilestonesForARepository

      GETListMilestonesForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • statestring

        The state of the milestone. Either open, closed, or all. Default: open

      • sortstring

        What to sort results by. Either due_on or completeness. Default: due_on

      • directionstring

        The direction of the sort. Either asc or desc. Default: asc

    • getASingleMilestone

      GETGetASingleMilestone

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • milestone_number*string

        Milestone_number

    • createAMilestone

      POSTCreateAMilestone

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • title*string

        The title of the milestone.

      • statestring

        The state of the milestone. Either open or closed. Default: open

      • descriptionstring

        A description of the milestone.

      • due_onstring

        The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • updateAMilestone

      PATCHUpdateAMilestone

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • milestone_number*string

        Milestone_number

      Request body

      • titlestring

        The title of the milestone.

      • statestring

        The state of the milestone. Either open or closed. Default: open

      • descriptionstring

        A description of the milestone.

      • due_onstring

        The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • deleteAMilestone

      DELETEDeleteAMilestone

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • milestone_number*string

        Milestone_number

  • Issues

    • List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories

      This action list all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you. See the Parameters table for more information.

      GETListIssues

      Request parameters

      • filterstring

        Indicates 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

      • statestring

        Indicates the state of the issues to return. Can be either open, closed, or all. Default: open

      • labelsstring

        A list of comma separated label names. Example: bug,ui,@high

      • sortstring

        What to sort results by. Can be either created, updated, comments. Default: created

      • directionstring

        The direction of the sort. Can be either asc or desc. Default: desc

      • sincestring

        Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories

      This action list all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you. See the Parameters table for more information.

      GETListAllIssuesAcrossOwnedAndMemberRepositoriesAssignedToTheAuthenticatedUser

      Request parameters

      • filterstring

        Indicates 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

      • statestring

        Indicates the state of the issues to return. Can be either open, closed, or all. Default: open

      • labelsstring

        A list of comma separated label names. Example: bug,ui,@high

      • sortstring

        What to sort results by. Can be either created, updated, comments. Default: created

      • directionstring

        The direction of the sort. Can be either asc or desc. Default: desc

      • sincestring

        Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories

      This action list all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you. See the Parameters table for more information.

      GETListAllIssuesForAGivenOrganizationAssignedToTheAuthenticatedUser

      Request parameters

      • org*string

        Org

      • filterstring

        Indicates 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

      • statestring

        Indicates the state of the issues to return. Can be either open, closed, or all. Default: open

      • labelsstring

        A list of comma separated label names. Example: bug,ui,@high

      • sortstring

        What to sort results by. Can be either created, updated, comments. Default: created

      • directionstring

        The direction of the sort. Can be either asc or desc. Default: desc

      • sincestring

        Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • listIssuesForARepository

      GETListIssuesForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • milestonestring

        If 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.

      • statestring

        Indicates the state of the issues to return. Can be either open, closed, or all. Default: open

      • assigneestring

        Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

      • creatorstring

        The user that created the issue.

      • mentionedstring

        A user that's mentioned in the issue.

      • labelsstring

        A list of comma separated label names. Example: bug,ui,@high

      • sortstring

        What to sort results by. Can be either created, updated, comments. Default: created

      • directionstring

        The direction of the sort. Can be either asc or desc. Default: desc

      • sincestring

        Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • The API returns a 301 Moved Permanently status if the issue was transferred to another repository

      This action the API returns a 301 Moved Permanently status if the issue was transferred to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook.

      GETGetASingleIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

    • Any user with pull access to a repository can create an issue

      This action any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

      POSTCreateAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • title*string

        The title of the issue.

      • bodystring

        The contents of the issue.

      • assigneestring

        Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

      • milestoneinteger

        The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

      • labelsarray

        Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

      • assigneesarray

        Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

    • User with push access can lock an issue or pull request's conversation

      This action users with push access can lock an issue or pull request's conversation.

      PUTLockAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • lock_reasonstring

        The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

    • Issue owners and users with push access can edit an issue

      This action issue owners and users with push access can edit an issue.

      PATCHEditAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • titlestring

        The title of the issue.

      • bodystring

        The contents of the issue.

      • statestring

        State of the issue. Either open or closed.

      • milestoneinteger

        The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

      • labelsarray

        Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

      • assigneesarray

        Logins 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.

    • User with push access can unlock an issue's conversation

      This action users with push access can unlock an issue's conversation.

      DELETEUnlockAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

  • Projects

    • List the projects in a repository

      This action lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      GETListRepositoryProjects

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • statestring

        Indicates the state of the projects to return. Can be either open, closed, or all. Default: open

    • List the projects in an organization

      This action lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      GETListOrganizationProjects

      Request parameters

      • org*string

        Org

      • statestring

        Indicates the state of the projects to return. Can be either open, closed, or all. Default: open

    • listUserProjects

      GETListUserProjects

      Request parameters

      • username*string

        Username

      • statestring

        Indicates the state of the projects to return. Can be either open, closed, or all. Default: open

    • Get a project by its id

      This action gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      GETGetAProject

      Request parameters

      • project_id*string

        Project_id

    • Create a repository project board

      This action creates a repository project board. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      POSTCreateARepositoryProject

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • name*string

        The name of the project.

      • bodystring

        The description of the project.

    • Create an organization project board

      This action creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      POSTCreateAnOrganizationProject

      Request parameters

      • org*string

        Org

      Request body

      • name*string

        The name of the project.

      • bodystring

        The description of the project.

    • createAUserProject

      POSTCreateAUserProject

      Request body

      • name*string

        The name of the project.

      • bodystring

        The description of the project.

    • Update a project board's information

      This action updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

      PATCHUpdateAProject

      Request parameters

      • project_id*string

        Project_id

      Request body

      • namestring

        The name of the project.

      • bodystring

        The description of the project.

      • statestring

        State of the project. Either open or closed.

      • organization_permissionstring

        The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting organization_permission is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by organization_permission. For information on changing access for a team or collaborator, see Add or update team project or Add user as a collaborator. Note: Updating a project's organization_permission requires admin access to the project.

      • privateboolean

        Sets the visibility of a project board. Setting private is only available for organization and user projects. Note: Updating a project's visibility requires admin access to the project. Can be one of: * false - Anyone can see the project. * true - Only the user can view a project board created on a user account. Organization members with the appropriate organization_permission can see project boards in an organization account.

    • Delete a project board

      This action deletes a project board. Returns a 404 Not Found status if projects are disabled.

      DELETEDeleteAProject

      Request parameters

      • project_id*string

        Project_id

  • Projectcards

    • listProjectCards

      GETListProjectCards

      Request parameters

      • column_id*string

        Column_id

      • archived_statestring

        Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived. Default: not_archived

    • getAProjectCard

      GETGetAProjectCard

      Request parameters

      • card_id*string

        Card_id

    • createAProjectCard

      POSTCreateAProjectCard

      Request parameters

      • column_id*string

        Column_id

      Request body

      • notestring

        The card's note content. Only valid for cards without another type of content, so you must omit when specifying content_id and content_type.

      • content_idinteger

        The issue or pull request id you want to associate with this card. You can use the List issues for a repository and List pull requests endpoints to find this id. Note: Depending on whether you use the issue id or pull request id, you will need to specify Issue or PullRequest as the content_type.

      • content_typestring

        Required if you provide content_id. The type of content you want to associate with this card. Use Issue when content_id is an issue id and use PullRequest when content_id is a pull request id.

    • moveAProjectCard

      POSTMoveAProjectCard

      Request parameters

      • card_id*string

        Card_id

      Request body

      • position*string

        Can be one of top, bottom, or after:, where is the id value of a card in the same column, or in the new column specified by column_id.

      • column_idinteger

        The id value of a column in the same project.

    • updateAProjectCard

      PATCHUpdateAProjectCard

      Request parameters

      • card_id*string

        Card_id

      Request body

      • notestring

        The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.

      • archivedboolean

        Use true to archive a project card. Specify false if you need to restore a previously archived project card.

    • deleteAProjectCard

      DELETEDeleteAProjectCard

      Request parameters

      • card_id*string

        Card_id

  • Projectcolumns

    • listProjectColumns

      GETListProjectColumns

      Request parameters

      • project_id*string

        Project_id

    • getAProjectColumn

      GETGetAProjectColumn

      Request parameters

      • column_id*string

        Column_id

    • createAProjectColumn

      POSTCreateAProjectColumn

      Request parameters

      • project_id*string

        Project_id

      Request body

      • name*string

        The name of the column.

    • moveAProjectColumn

      POSTMoveAProjectColumn

      Request parameters

      • column_id*string

        Column_id

      Request body

      • positionstring

        Can be one of first, last, or after:, where is the id value of a column in the same project.

    • updateAProjectColumn

      PATCHUpdateAProjectColumn

      Request parameters

      • column_id*string

        Column_id

      Request body

      • name*string

        The new name of the column.

    • deleteAProjectColumn

      DELETEDeleteAProjectColumn

      Request parameters

      • column_id*string

        Column_id

  • PublicKeys

    • List the verified public SSH keys for a user

      This action lists the verified public SSH keys for a user. This is accessible by anyone.

      GETListPublicKeysForAUser

      Request parameters

      • username*string

        Username

    • List the public SSH keys for the authenticated user's GitHub account

      This action lists the public SSH keys for the authenticated user's GitHub account.

      GETListYourPublicKeys
    • View extended details for a single public SSH key

      This action view extended details for a single public SSH key.

      GETGetASinglePublicKey

      Request parameters

      • key_id*string

        Key_id

    • Add a public SSH key to the authenticated user's GitHub account

      This action adds a public SSH key to the authenticated user's GitHub account.

      POSTCreateAPublicKey

      Request body

      • titlestring

        A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

      • keystring

        The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.

    • Remove a public SSH key from the authenticated user's GitHub account

      This action removes a public SSH key from the authenticated user's GitHub account.

      DELETEDeleteAPublicKey

      Request parameters

      • key_id*string

        Key_id

  • PullRequests

    • listPullRequests

      GETListPullRequests

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • statestring

        Either open, closed, or all to filter by state. Default: open

      • headstring

        Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

      • basestring

        Filter pulls by base branch name. Example: gh-pages.

      • sortstring

        What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month). Default: created

      • directionstring

        The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

    • List details of a pull request by providing its number

      This action lists details of a pull request by providing its number.

      GETGetASinglePullRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

    • List a maximum of 250 commits for a pull request

      This action lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the Commit List API.

      GETListCommitsOnAPullRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

    • Note: Responses include a maximum of 3000 files

      This action note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

      GETListPullRequestsFiles

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

    • getIfAPullRequestHasBeenMerged

      GETGetIfAPullRequestHasBeenMerged

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

    • To open or update a pull request in a public repository, you must have write access to the head or the source branch

      This action to open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. You can create a new pull request.

      POSTCreateAPullRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • title*string

        The title of the new pull request.

      • head*string

        The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

      • base*string

        The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

      • bodystring

        The contents of the pull request.

      • maintainer_can_modifyboolean

        Indicates whether maintainers can modify the pull request.

      • draftboolean

        Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.

    • Update the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch

      This action updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.

      PUTUpdateAPullRequestBranch

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      Request body

      • expected_head_shastring

        The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits on a repository" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

    • This endpoint triggers notifications

      This action this endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      PUTMergeAPullRequestMergeButton

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      Request body

      • commit_titlestring

        Title for the automatic commit message.

      • commit_messagestring

        Extra detail to append to automatic commit message.

      • shastring

        SHA that pull request head must match to allow merge.

      • merge_methodstring

        Merge method to use. Possible values are merge, squash or rebase. Default is merge.

    • To open or update a pull request in a public repository, you must have write access to the head or the source branch

      This action to open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

      PATCHUpdateAPullRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      Request body

      • titlestring

        The title of the pull request.

      • bodystring

        The contents of the pull request.

      • statestring

        State of this Pull Request. Either open or closed.

      • basestring

        The 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.

      • maintainer_can_modifyboolean

        Indicates whether maintainers can modify the pull request.

  • Reviews

    • listReviewsOnAPullRequest

      GETListReviewsOnAPullRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

    • getASingleReview

      GETGetASingleReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • review_id*string

        Review_id

    • getCommentsForASingleReview

      GETGetCommentsForASingleReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • review_id*string

        Review_id

    • This endpoint triggers notifications

      This action this endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateAPullRequestReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      Request body

      • commit_idstring

        The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

      • bodystring

        Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

      • eventstring

        The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

      • commentsarray

        Use the following table to specify the location, destination, and contents of the draft review comment.

    • submitAPullRequestReview

      POSTSubmitAPullRequestReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • review_id*string

        Review_id

      Request body

      • event*string

        The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

      • bodystring

        The body text of the pull request review

    • Update the review summary comment with new text

      This action update the review summary comment with new text.

      PUTUpdateAPullRequestReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • review_id*string

        Review_id

      Request body

      • body*string

        The body text of the pull request review.

    • dismissAPullRequestReview

      PUTDismissAPullRequestReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • review_id*string

        Review_id

      Request body

      • message*string

        The message for the pull request review dismissal

    • deleteAPendingReview

      DELETEDeleteAPendingReview

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • review_id*string

        Review_id

  • GitReferences

    • Return a single reference from your Git database

      This action returns a single reference from your Git database. The :ref in the URL must be formatted as heads/ for branches and tags/ for tags. If the :ref doesn't match an existing ref, a 404 is returned.

      GETGetASingleReference

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

    • Return an array of references from your Git database that match the supplied name

      This action returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/ for branches and tags/ for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

      GETListMatchingReferences

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

    • Create a reference for your repository

      This action creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

      POSTCreateAReference

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • ref*string

        The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

      • sha*string

        The SHA1 value for this reference.

    • updateAReference

      PATCHUpdateAReference

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

      Request body

      • sha*string

        The SHA1 value to set this reference to

      • forceboolean

        Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work. Default: false

    • deleteAReference

      DELETEDeleteAReference

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

  • Self-hostedrunners

    • List binaries for the self-hosted runner application that you can download and run

      This action lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

      GETListDownloadsForTheSelfHostedRunnerApplication

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • List all self-hosted runners for a repository

      This action lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

      GETListSelfHostedRunnersForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Get a specific self-hosted runner

      This action gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

      GETGetASelfHostedRunner

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • runner_id*string

        Runner_id

    • Return a token that you can pass to the config script

      This action returns a token that you can pass to the config script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

      POSTCreateARegistrationToken

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Return a token that you can pass to remove a self-hosted runner from a repository

      This action returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

      POSTCreateARemoveToken

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Force the removal of a self-hosted runner from a repository

      This action forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the administration permission to use this endpoint.

      DELETERemoveASelfHostedRunner

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • runner_id*string

        Runner_id

  • Releases

    • Information about published releases are available to everyone

      This action information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

      GETListReleasesForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getASingleRelease

      GETGetASingleRelease

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • release_id*string

        Release_id

    • View the latest published full release for the repository

      This action view the latest published full release for the repository. The latest release is the most recent non-prerelease, non-draft release, sorted by the created_at attribute. The created_at attribute is the date of the commit used for the release, and not the date when the release was drafted or published.

      GETGetTheLatestRelease

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Get a published release with the specified tag

      This action get a published release with the specified tag.

      GETGetAReleaseByTagName

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • tag*string

        Tag

    • listAssetsForARelease

      GETListAssetsForARelease

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • release_id*string

        Release_id

    • getASingleReleaseAsset

      GETGetASingleReleaseAsset

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • asset_id*string

        Asset_id

    • User with push access to the repository can create a release

      This action users with push access to the repository can create a release. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateARelease

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • tag_name*string

        The name of the tag.

      • target_commitishstring

        Specifies 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).

      • namestring

        The name of the release.

      • bodystring

        Text describing the contents of the tag.

      • draftboolean

        true to create a draft (unpublished) release, false to create a published one. Default: false

      • prereleaseboolean

        true to identify the release as a prerelease. false to identify the release as a full release. Default: false

    • User with push access to the repository can edit a release

      This action users with push access to the repository can edit a release.

      PATCHEditARelease

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • release_id*string

        Release_id

      Request body

      • tag_namestring

        The name of the tag.

      • target_commitishstring

        Specifies 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).

      • namestring

        The name of the release.

      • bodystring

        Text describing the contents of the tag.

      • draftboolean

        true makes the release a draft, and false publishes the release.

      • prereleaseboolean

        true to identify the release as a prerelease, false to identify the release as a full release.

    • User with push access to the repository can edit a release asset

      This action users with push access to the repository can edit a release asset.

      PATCHEditAReleaseAsset

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • asset_id*string

        Asset_id

      Request body

      • namestring

        The file name of the asset.

      • labelstring

        An alternate short description of the asset. Used in place of the filename.

    • User with push access to the repository can delete a release

      This action users with push access to the repository can delete a release.

      DELETEDeleteARelease

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • release_id*string

        Release_id

    • deleteAReleaseAsset

      DELETEDeleteAReleaseAsset

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • asset_id*string

        Asset_id

  • ReviewComments

    • List review comments for a pull request

      This action lists review comments for a pull request. By default, review comments are in ascending order by ID.

      GETListCommentsOnAPullRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • sortstring

        Can be either created or updated comments. Default: created

      • directionstring

        Can be either asc or desc. Ignored without sort parameter.

      • sincestring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

    • List review comments for all pull requests in a repository

      This action lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.

      GETListCommentsInARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • sortstring

        Can be either created or updated comments. Default: created

      • directionstring

        Can be either asc or desc. Ignored without sort parameter.

      • sincestring

        This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

    • Create a reply to a review comment for a pull request

      This action creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateAReviewCommentReply

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      • comment_id*string

        Comment_id

      Request body

      • body*string

        The text of the review comment.

  • ReviewRequests

    • listReviewRequests

      GETListReviewRequests

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

    • This endpoint triggers notifications

      This action this endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See "Abuse rate limits" and "Dealing with abuse rate limits" for details.

      POSTCreateAReviewRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      Request body

      • reviewersarray

        An array of user logins that will be requested.

      • team_reviewersarray

        An array of team slugs that will be requested.

    • deleteAReviewRequest

      DELETEDeleteAReviewRequest

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • pull_number*string

        Pull_number

      Request body

      • reviewersarray

        An array of user logins that will be removed.

      • team_reviewersarray

        An array of team slugs that will be removed.

  • Statuses

    • User with pull access in a repository can view commit statuses for a given ref

      This action users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

      GETListStatusesForASpecificRef

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

    • User with pull access in a repository can access a combined view of commit statuses for a given ref

      This action users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.

      GETGetTheCombinedStatusForASpecificRef

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • ref*string

        Ref

    • User with push access in a repository can create commit statuses for a given SHA

      This action users with push access in a repository can create commit statuses for a given SHA. Note: there is a limit of 1000 statuses per sha and context within a repository. Attempts to create more than 1000 statuses will result in a validation error.

      POSTCreateAStatus

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • sha*string

        Sha

      Request body

      • state*string

        The state of the status. Can be one of error, failure, pending, or success.

      • target_urlstring

        The target 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. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha

      • descriptionstring

        A short description of the status.

      • contextstring

        A string label to differentiate this status from the status of other systems. Default: default

  • GitTags

    • getATag

      GETGetATag

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • tag_sha*string

        Tag_sha

    • Note that creating a tag object does not create the reference that makes a tag in Git

      This action note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

      POSTCreateATagObject

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • tag*string

        The tag's name. This is typically a version (e.g., "v0.0.1").

      • message*string

        The tag message

      • object*string

        The SHA of the git object this is tagging.

      • type*string

        The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

      • taggerobject

        An object with information about the individual creating the tag.

  • GitTrees

    • Return a single tree using the SHA1 value for that tree

      This action returns a single tree using the SHA1 value for that tree.

      GETGetATree

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • tree_sha*string

        Tree_sha

      • recursiveboolean

        Whether to get a tree recursively

    • The tree creation API accepts nested entries

      This action the tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference."

      POSTCreateATree

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • tree*array

        Objects (of path, mode, type, and sha) specifying a tree structure.

      • base_treestring

        The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.

  • Contents

    • Get the preferred README for a repository

      This action gets the preferred README for a repository.

      GETGetTheREADME

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • refstring

        The name of the commit/branch/tag. Default: the repository's default branch (usually master)

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

      This action gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit :path, you will receive the contents of all files in the repository.

      GETGetContents

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • path*string

        Path

      • refstring

        The name of the commit/branch/tag. Default: the repository's default branch (usually master)

    • Get a redirect URL to download an archive for a repository

      This action gets a redirect URL to download an archive for a repository.

      GETGetArchiveLink

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • archive_format*string

        Archive_format

      • ref*string

        Ref

    • Create a new file or updates an existing file in a repository

      This action creates a new file or updates an existing file in a repository.

      PUTCreateOrUpdateAFile

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • path*string

        Path

      Request body

      • message*string

        The commit message.

      • content*string

        The new file content, using Base64 encoding.

      • shastring

        Required if you are updating a file. The blob SHA of the file being replaced.

      • branchstring

        The branch name. Default: the repository's default branch (usually master)

      • committerobject

        The person that committed the file. Default: the authenticated user.

      • authorobject

        The author of the file. Default: The committer or the authenticated user if you omit committer.

    • Delete a file in a repository

      This action deletes a file in a repository.

      DELETEDeleteAFile

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • path*string

        Path

      Request body

      • message*string

        The commit message.

      • sha*string

        The blob SHA of the file being replaced.

      • branchstring

        The branch name. Default: the repository's default branch (usually master)

  • Secrets

    • Get your public key, which you must store

      This action gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned key to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

      GETGetYourPublicKey

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • List all secrets available in a repository without revealing their encrypted values

      This action lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

      GETListSecretsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Get a single secret without revealing its encrypted value

      This action gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

      GETGetASecret

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • name*string

        Name

    • Create or updates a secret with an encrypted value

      This action creates or updates a secret with an encrypted value. Encrypt your secret using LibSodium. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

      PUTCreateOrUpdateASecretForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • name*string

        Name

      Request body

      • encrypted_valuestring

        Value for your secret, encrypted with LibSodium using the public key retrieved from the Get your public key endpoint.

      • key_idstring

        ID of the key you used to encrypt the secret.

    • Delete a secret in a repository using the secret name

      This action deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the secrets permission to use this endpoint.

      DELETEDeleteASecretFromARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • name*string

        Name

  • Teamsynchronization

    • List IdP groups available in an organization

      This action list IdP groups available in an organization. You can limit your page results using the per_page parameter. GitHub generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see "Offset and Cursor Pagination explained."

      GETListIdPGroupsInAnOrganization

      Request parameters

      • org*string

        Org

    • List IdP groups connected to a team on GitHub

      This action list IdP groups connected to a team on GitHub.

      GETListIdPGroupsForATeam

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

    • Creates, updates, or removes a connection between a team and an IdP group

      This action creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

      PATCHCreateOrUpdateIdPGroupConnections

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      Request body

      • groups*array

        The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • Reactions

    • List the reactions to a commit comment

      This action list the reactions to a commit comment.

      GETListReactionsForACommitComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      • contentstring

        Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

    • List the reactions to an issue

      This action list the reactions to an issue.

      GETListReactionsForAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      • contentstring

        Returns a single reaction type. Omit this parameter to list all reactions to an issue.

    • List the reactions to an issue comment

      This action list the reactions to an issue comment.

      GETListReactionsForAnIssueComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      • contentstring

        Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

    • List the reactions to a pull request review comment

      This action list the reactions to a pull request review comment.

      GETListReactionsForAPullRequestReviewComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      • contentstring

        Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

    • List the reactions to a team discussion

      This action list the reactions to a team discussion.

      GETListReactionsForATeamDiscussion

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • contentstring

        Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

    • List the reactions to a team discussion comment

      This action list the reactions to a team discussion comment

      GETListReactionsForATeamDiscussionComment

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • comment_number*string

        Comment_number

      • contentstring

        Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

    • Create a reaction to a commit comment

      This action create a reaction to a commit comment. A response with a Status: 200 OK means that you already added the reaction type to this commit comment.

      POSTCreateReactionForACommitComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      Request body

      • content*string

        The reaction type to add to the commit comment.

    • Create a reaction to an issue

      This action create a reaction to an issue. A response with a Status: 200 OK means that you already added the reaction type to this issue.

      POSTCreateReactionForAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      Request body

      • content*string

        The reaction type to add to the issue.

    • Create a reaction to an issue comment

      This action create a reaction to an issue comment. A response with a Status: 200 OK means that you already added the reaction type to this issue comment.

      POSTCreateReactionForAnIssueComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      Request body

      • content*string

        The reaction type to add to the issue comment.

    • Create a reaction to a pull request review comment

      This action create a reaction to a pull request review comment. A response with a Status: 200 OK means that you already added the reaction type to this pull request review comment.

      POSTCreateReactionForAPullRequestReviewComment

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • comment_id*string

        Comment_id

      Request body

      • content*string

        The reaction type to add to the pull request review comment.

    • Create a reaction to a team discussion

      This action create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

      POSTCreateReactionForATeamDiscussion

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      Request body

      • content*string

        The reaction type to add to the team discussion.

    • Create a reaction to a team discussion comment

      This action create a reaction to a team discussion comment.

      POSTCreateReactionForATeamDiscussionComment

      Request parameters

      • org*string

        Org

      • team_slug*string

        Team_slug

      • discussion_number*string

        Discussion_number

      • comment_number*string

        Comment_number

      Request body

      • content*string

        The reaction type to add to the team discussion comment.

    • deleteAReaction

      DELETEDeleteAReaction

      Request parameters

      • reaction_id*string

        Reaction_id

  • Artifacts

    • List artifacts for a workflow run

      This action lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETListWorkflowRunArtifacts

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • run_id*string

        Run_id

    • Get a specific artifact for a workflow run

      This action gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETGetAnArtifact

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • artifact_id*string

        Artifact_id

    • Get a redirect URL to download an archive for a repository

      This action gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in the response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETDownloadAnArtifact

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • artifact_id*string

        Artifact_id

      • archive_format*string

        Archive_format

    • Delete an artifact for a workflow run

      This action deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      DELETEDeleteAnArtifact

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • artifact_id*string

        Artifact_id

  • Organizationmigrations

    • List the most recent migrations

      This action lists the most recent migrations.

      GETListOrganizationMigrations

      Request parameters

      • org*string

        Org

    • Fetch the status of a migration

      This action fetches the status of a migration.

      GETGetTheStatusOfAnOrganizationMigration

      Request parameters

      • org*string

        Org

      • migration_id*string

        Migration_id

    • List all the repositories for this organization migration

      This action list all the repositories for this organization migration.

      GETListRepositoriesInAnOrganizationMigration

      Request parameters

      • org*string

        Org

      • migration_id*string

        Migration_id

    • Fetch the URL to a migration archive

      This action fetches the URL to a migration archive.

      GETDownloadAnOrganizationMigrationArchive

      Request parameters

      • org*string

        Org

      • migration_id*string

        Migration_id

    • Initiate the generation of a migration archive

      This action initiates the generation of a migration archive.

      POSTStartAnOrganizationMigration

      Request parameters

      • org*string

        Org

      Request body

      • repositories*array

        A list of arrays indicating which repositories should be migrated.

      • lock_repositoriesboolean

        Indicates whether repositories should be locked (to prevent manipulation) while migrating data. Default: false.

      • exclude_attachmentsboolean

        Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). Default: false.

    • Delete a previous migration archive

      This action deletes a previous migration archive. Migration archives are automatically deleted after seven days.

      DELETEDeleteAnOrganizationMigrationArchive

      Request parameters

      • org*string

        Org

      • migration_id*string

        Migration_id

    • Unlock a repository that was locked for migration

      This action unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

      DELETEUnlockAnOrganizationRepository

      Request parameters

      • org*string

        Org

      • migration_id*string

        Migration_id

      • repo_name*string

        Repo_name

  • Notifications

    • List all notifications for the current user, sorted by most recently updated

      This action list all notifications for the current user, sorted by most recently updated.

      GETListYourNotifications

      Request parameters

      • allboolean

        If true, show notifications marked as read. Default: false

      • participatingboolean

        If true, only shows notifications in which the user is directly participating or mentioned. Default: false

      • sincestring

        Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • beforestring

        Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • List all notifications for the current user

      This action list all notifications for the current user.

      GETListYourNotificationsInARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • allboolean

        If true, show notifications marked as read. Default: false

      • participatingboolean

        If true, only shows notifications in which the user is directly participating or mentioned. Default: false

      • sincestring

        Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

      • beforestring

        Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    • viewASingleThread

      GETViewASingleThread

      Request parameters

      • thread_id*string

        Thread_id

    • This checks to see if the current user is subscribed to a thread

      This action this checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

      GETGetAThreadSubscription

      Request parameters

      • thread_id*string

        Thread_id

    • Mark a notification as "read" removes it from the default view on GitHub

      This action marks a notification as "read" removes it from the default view on GitHub.

      PUTMarkAsRead

      Request body

      • last_read_atstring

        Describes 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: The current timestamp.

    • Mark all notifications in a repository as "read" removes them from the default view on GitHub

      This action marks all notifications in a repository as "read" removes them from the default view on GitHub.

      PUTMarkNotificationsAsReadInARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • last_read_atstring

        Describes 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: The current timestamp.

    • This lets you subscribe or unsubscribe from a conversation

      This action this lets you subscribe or unsubscribe from a conversation.

      PUTSetAThreadSubscription

      Request parameters

      • thread_id*string

        Thread_id

      Request body

      • ignoredboolean

        Unsubscribes and subscribes you to a conversation. Set ignored to true to block all notifications from this thread. Default: false

    • markAThreadAsRead

      PATCHMarkAThreadAsRead

      Request parameters

      • thread_id*string

        Thread_id

    • Mute all future notifications for a conversation until you comment on the thread or get @mentioned

      This action mutes all future notifications for a conversation until you comment on the thread or get @mentioned.

      DELETEDeleteAThreadSubscription

      Request parameters

      • thread_id*string

        Thread_id

  • Usermigrations

    • List all migrations a user has started

      This action lists all migrations a user has started.

      GETListUserMigrations
    • Fetch a single user migration

      This action fetches a single user migration. The response includes the state of the migration, which can be one of the following values: pending - the migration hasn't started yet. exporting - the migration is in progress. exported - the migration finished successfully. failed - the migration failed.

      GETGetTheStatusOfAUserMigration

      Request parameters

      • migration_id*string

        Migration_id

    • List all the repositories for this user migration

      This action lists all the repositories for this user migration.

      GETListRepositoriesForAUserMigration

      Request parameters

      • migration_id*string

        Migration_id

    • Fetch the URL to download the migration archive as a tar

      This action fetches the URL to download the migration archive as a tar.gz file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: attachments bases commit_comments issue_comments issue_events issues milestones organizations projects protected_branches pull_request_reviews pull_requests releases repositories review_comments schema users

      GETDownloadAUserMigrationArchive

      Request parameters

      • migration_id*string

        Migration_id

    • Initiate the generation of a user migration archive

      This action initiates the generation of a user migration archive.

      POSTStartAUserMigration

      Request body

      • repositories*array

        An array of repositories to include in the migration.

      • lock_repositoriesboolean

        Locks the repositories to prevent changes during the migration when set to true. Default: false

      • exclude_attachmentsboolean

        Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size. Default: false

    • Delete a previous migration archive

      This action deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get the status of a user migration endpoints, will continue to be available even after an archive is deleted.

      DELETEDeleteAUserMigrationArchive

      Request parameters

      • migration_id*string

        Migration_id

    • Unlock a repository

      This action unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

      DELETEUnlockAUserRepository

      Request parameters

      • migration_id*string

        Migration_id

      • repo_name*string

        Repo_name

  • Pages

    • getInformationAboutAPagesSite

      GETGetInformationAboutAPagesSite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listPagesBuilds

      GETListPagesBuilds

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getLatestPagesBuild

      GETGetLatestPagesBuild

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getASpecificPagesBuild

      GETGetASpecificPagesBuild

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • build_id*string

        Build_id

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.

      POSTEnableAPagesSite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • sourceobject

        Source object

    • You can request that your site be built from the latest revision on the default branch

      This action you can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

      POSTRequestAPageBuild

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • updateInformationAboutAPagesSite

      PUTUpdateInformationAboutAPagesSite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • cnamestring

        Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

      • sourcestring

        Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".

    • Warning: The API may change without advance notice during the preview period

      This action warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support or GitHub Premium Support.

      DELETEDisableAPagesSite

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Organizations

    • List organizations for the authenticated user

      This action list organizations for the authenticated user.

      GETListYourOrganizations
    • List all organizations, in the order that they were created on GitHub

      This action lists all organizations, in the order that they were created on GitHub.

      GETListAllOrganizations

      Request parameters

      • sinceinteger

        The integer ID of the last organization that you've seen.

    • List public organization memberships for the specified user

      This action list public organization memberships for the specified user.

      GETListUserOrganizations

      Request parameters

      • username*string

        Username

    • List all GitHub Apps in an organization

      This action lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

      GETListInstallationsForAnOrganization

      Request parameters

      • org*string

        Org

    • To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope

      This action to see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

      GETGetAnOrganization

      Request parameters

      • org*string

        Org

    • An authenticated organization owner with the read:org scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO)

      This action an authenticated organization owner with the read:org scope can list all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization.

      GETListCredentialAuthorizationsForAnOrganization

      Request parameters

      • org*string

        Org

    • Enable an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges

      This action enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.

      PATCHEditAnOrganization

      Request parameters

      • org*string

        Org

      Request body

      • billing_emailstring

        Billing email address. This address is not publicized.

      • companystring

        The company name.

      • emailstring

        The publicly visible email address.

      • locationstring

        The location.

      • namestring

        The shorthand name of the company.

      • descriptionstring

        The description of the company.

      • has_organization_projectsboolean

        Toggles whether an organization can use organization projects.

      • has_repository_projectsboolean

        Toggles whether repositories that belong to the organization can use repository projects.

      • default_repository_permissionstring

        Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default. Default: read

      • members_can_create_repositoriesboolean

        Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories.* false - only organization owners can create repositories. Default: true. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

      • members_can_create_internal_repositoriesboolean

        Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: * true - all organization members can create internal repositories. * false - only organization owners can create internal repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

      • members_can_create_private_repositoriesboolean

        Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * true - all organization members can create private repositories. * false - only organization owners can create private repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

      • members_can_create_public_repositoriesboolean

        Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * true - all organization members can create public repositories. * false - only organization owners can create public repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

      • members_allowed_repository_creation_typestring

        Specifies which types of repositories non-admin organization members can create. Can be one of: * all - all organization members can create public and private repositories. * private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. * none - only admin members can create repositories. Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See this note for details.

    • An authenticated organization owner with the admin:org scope can remove a credential authorization for an organization that uses SAML SSO

      This action an authenticated organization owner with the admin:org scope can remove a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access.

      DELETERemoveACredentialAuthorizationForAnOrganization

      Request parameters

      • org*string

        Org

      • credential_id*string

        Credential_id

  • SCIM

    • getAListOfProvisionedIdentities

      GETGetAListOfProvisionedIdentities

      Request parameters

      • org*string

        Org

      • startIndexinteger

        Used for pagination: the index of the first result to return.

      • countinteger

        Used for pagination: the number of results to return.

      • filterstring

        Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\".

    • getProvisioningDetailsForASingleUser

      GETGetProvisioningDetailsForASingleUser

      Request parameters

      • org*string

        Org

      • scim_user_id*string

        Scim_user_id

    • Provision organization membership for a user, and send an activation email to the email address

      This action provision organization membership for a user, and send an activation email to the email address.

      POSTProvisionAndInviteUsers

      Request parameters

      • org*string

        Org

    • removeAUserFromTheOrganization

      DELETERemoveAUserFromTheOrganization

      Request parameters

      • org*string

        Org

      • scim_user_id*string

        Scim_user_id

  • Users

    • Provide publicly available information about someone with a GitHub account

      This action provides publicly available information about someone with a GitHub account.

      GETGetASingleUser

      Request parameters

      • username*string

        Username

    • getTheAuthenticatedUser

      GETGetTheAuthenticatedUser
    • Provide hovercard information when authenticated through basic auth or OAuth with the repo scope

      This action provides hovercard information when authenticated through basic auth or OAuth with the repo scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

      GETGetContextualInformationAboutAUser

      Request parameters

      • username*string

        Username

      • subject_typestring

        Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

      • subject_idstring

        Uses the ID for the subject_type you specified. Required when using subject_type.

    • List all users, in the order that they signed up on GitHub

      This action lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

      GETGetAllUsers

      Request parameters

      • sincestring

        The integer ID of the last User that you've seen.

    • updateTheAuthenticatedUser

      PATCHUpdateTheAuthenticatedUser

      Request body

      • namestring

        The new name of the user.

      • emailstring

        The publicly visible email address of the user.

      • blogstring

        The new blog URL of the user.

      • companystring

        The new company of the user.

      • locationstring

        The new location of the user.

      • hireableboolean

        The new hiring availability of the user.

      • biostring

        The new short biography of the user.

  • CodesofConduct

    • listAllCodesOfConduct

      GETListAllCodesOfConduct
    • getAnIndividualCodeOfConduct

      GETGetAnIndividualCodeOfConduct

      Request parameters

      • key*string

        Key

    • When passed the preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file

      This action when passed the preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.

      GETGetARepositorysCodeOfConduct

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • This method returns the contents of the repository's code of conduct file, if one is detected

      This action this method returns the contents of the repository's code of conduct file, if one is detected.

      GETGetTheContentsOfARepositorysCodeOfConduct

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Licenses

    • listCommonlyUsedLicenses

      GETListCommonlyUsedLicenses
    • getAnIndividualLicense

      GETGetAnIndividualLicense

      Request parameters

      • license*string

        License

    • This method returns the contents of the repository's license file, if one is detected

      This action this method returns the contents of the repository's license file, if one is detected.

      GETGetTheContentsOfARepositorysLicense

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • IssuesEvents

    • listEventsForARepository

      GETListEventsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getASingleEvent

      GETGetASingleEvent

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • event_id*string

        Event_id

  • Gitignore

    • List all templates available to pass as an option when creating a repository

      This action list all templates available to pass as an option when creating a repository.

      GETListingAvailableTemplates
    • The API also allows fetching the source of a single template

      This action the API also allows fetching the source of a single template.

      GETGetASingleTemplate

      Request parameters

      • name*string

        Name

  • ActionsWorkflows

    • List the workflows in a repository

      This action lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETListRepositoryWorkflows

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Get a specific workflow

      This action gets a specific workflow. You can also replace :workflow_id with :workflow_file_name. For example, you could use main.yml. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETGetAWorkflow

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • workflow_id*string

        Workflow_id

  • WorkflowJobs

    • List jobs for a workflow run

      This action lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETListJobsForAWorkflowRun

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • run_id*string

        Run_id

    • Get a specific job in a workflow run

      This action gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETGetAWorkflowJob

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • job_id*string

        Job_id

    • Get a redirect URL to download a plain text file of logs for a workflow job

      This action gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for Location: in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the actions permission to use this endpoint.

      GETListWorkflowJobLogs

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • job_id*string

        Job_id

  • Statistics

    • getContributorsListWithAdditions,Deletions,AndCommitCounts

      GETGetContributorsListWithAdditionsDeletionsAndCommitCounts

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Return the last year of commit activity grouped by week

      This action returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.

      GETGetTheLastYearOfCommitActivityData

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getTheNumberOfAdditionsAndDeletionsPerWeek

      GETGetTheNumberOfAdditionsAndDeletionsPerWeek

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getTheWeeklyCommitCountForTheRepositoryOwnerAndEveryoneElse

      GETGetTheWeeklyCommitCountForTheRepositoryOwnerAndEveryoneElse

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • getTheNumberOfCommitsPerHourInEachDay

      GETGetTheNumberOfCommitsPerHourInEachDay

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Events

    • This is a read-only API to the GitHub events

      This action this is a read-only API to the GitHub events. These events power the various activity streams on the site.

      GETGetEvents

      Request parameters

      • user*string

        Github User ID

  • Feeds

  • Meta

    • This endpoint provides a list of GitHub's IP addresses

      This action this endpoint provides a list of GitHub's IP addresses. For more information, see ["About GitHub's IP addresses."](https://help.github.com/articles/about-github-s-ip-addresses/)

      GETGetMeta
  • RateLimit

  • GistsComments

    • listCommentsOnAGist

      GETListCommentsOnAGist

      Request parameters

      • gist_id*string

        Gist_id

  • IssuesComments

    • listCommentsOnAnIssue

      GETListCommentsOnAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

      • sincestring

        Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Timeline

    • listEventsForAnIssue

      GETListEventsForAnIssue

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      • issue_number*string

        Issue_number

  • ActivityEvents

    • We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago

      This action we delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

      GETListPublicEvents
    • listRepositoryEvents

      GETListRepositoryEvents

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • Repository issue events have a different format than other events, as documented in the [Issue Events API](https://developer

      This action repository issue events have a different format than other events, as documented in the [Issue Events API](https://developer.github.com/v3/issues/events/)

      GETListIssueEventsForARepository

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listPublicEventsForANetworkOfRepositories

      GETListPublicEventsForANetworkOfRepositories

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

    • listPublicEventsForAnOrganization

      GETListPublicEventsForAnOrganization

      Request parameters

      • org*string

        Org

    • These are events that you've received by watching repos and following users

      This action these are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

      GETListEventsThatAUserHasReceived

      Request parameters

      • username*string

        Username

    • listPublicEventsThatAUserHasReceived

      GETListPublicEventsThatAUserHasReceived

      Request parameters

      • username*string

        Username

    • If you are authenticated as the given user, you will see your private events

      This action if you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

      GETListEventsPerformedByAUser

      Request parameters

      • username*string

        Username

    • listPublicEventsPerformedByAUser

      GETListPublicEventsPerformedByAUser

      Request parameters

      • username*string

        Username

    • This is the user's organization dashboard

      This action this is the user's organization dashboard. You must be authenticated as the user to view this.

      GETListEventsForAnOrganization

      Request parameters

      • username*string

        Username

      • org*string

        Org

  • Emojis

    • listsAllTheEmojisAvailableToUseOnGitHub.

      GETListsAllTheEmojisAvailableToUseOnGitHub
  • Merging

    • performAMerge

      POSTPerformAMerge

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

      Request body

      • base*string

        The name of the base branch that the head will be merged into.

      • head*string

        The head to merge. This can be a branch name or a commit SHA1.

      • commit_messagestring

        Commit message to use for the merge commit. If omitted, a default message will be used.

  • Markdown

    • renderAnArbitraryMarkdownDocument

      POSTRenderAnArbitraryMarkdownDocument

      Request body

      • text*string

        The Markdown text to render in HTML. Markdown content must be 400 KB or less.

      • modestring

        The rendering mode. Can be either: * markdown to render a document in plain Markdown, just like README.md files are rendered. * gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests. Default: markdown

      • contextstring

        The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

  • CommunityProfile

    • This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files

      This action this endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE, README, and CONTRIBUTING files.

      GETRetrieveCommunityProfileMetrics

      Request parameters

      • owner*string

        Owner

      • repo*string

        Repo

  • Search

    • Find repositories via various criteria

      This action find repositories via various criteria. This method returns up to 100 results per page.

      GETSearchRepositories

      Request parameters

      • q*string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

      • sortstring

        Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

      • orderstring

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: desc

    • Find commits via various criteria

      This action find commits via various criteria. This method returns up to 100 results per page. When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

      GETSearchCommits

      Request parameters

      • q*string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

      • sortstring

        Sorts the results of your query by author-date or committer-date. Default: best match

      • orderstring

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: desc

    • Find file contents via various criteria

      This action find file contents via various criteria. This method returns up to 100 results per page. When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

      GETSearchCode

      Request parameters

      • q*string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

      • sortstring

        Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

      • orderstring

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: desc

    • Find issues by state and keyword

      This action find issues by state and keyword. This method returns up to 100 results per page. When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

      GETSearchIssuesAndPullRequests

      Request parameters

      • q*string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

      • sortstring

        Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

      • orderstring

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: desc

    • Find users via various criteria

      This action find users via various criteria. This method returns up to 100 results per page. When searching for users, you can get text match metadata for the issue login, email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

      GETSearchUsers

      Request parameters

      • q*string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

      • sortstring

        Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match

      • orderstring

        Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort. Default: desc

    • Find topics via various criteria

      This action find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

      GETSearchTopics

      Request parameters

      • q*string

        The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query.

    • Find labels in a repository with names or descriptions that match search keywords

      This action find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page. When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search