GitHub Forks API

openapi: 3.2.0
info:
  title: Github Forks API
  version: 1.1.4
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  description: 'Operations tagged Forks across 2 of this provider''s published API definitions: github-gists-openapi.yml, github-repo-tags-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: '{protocol}://{hostname}/api/v3'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: HOSTNAME
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: http
- url: '{protocol}://{hostname}'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: api.github.com
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: https
tags:
- name: Forks
paths:
  /gists/{gist_id}/forks:
    get:
      summary: GitHub List Gist Forks
      description: This API endpoint retrieves a list of all forks for a specific GitHub Gist identified by its gist_id parameter. When called with a GET request, it returns an array of fork objects, each containing details about users who have forked the gist, including their user information, the fork's creation date, and the forked gist's URL. This is useful for tracking how widely a gist has been shared and reused across the GitHub community, allowing developers to see who has created their own copy of the original gist and potentially made modifications to it.
      tags:
      - Forks
      operationId: listGistForks
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-gist-forks
      parameters:
      - $ref: '#/components/parameters/gist-id'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/gist-simple'
              examples:
                default:
                  $ref: '#/components/examples/gist-fork-items'
          headers:
            Link:
              $ref: '#/components/headers/link'
        '304':
          $ref: '#/components/responses/not_modified'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: false
        category: gists
        subcategory: gists
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: GitHub Forkgist
      description: This API endpoint allows authenticated users to create a fork (copy) of an existing gist by making a POST request to /gists/{gist_id}/forks, where {gist_id} is the unique identifier of the gist to be forked. When executed successfully, it creates a duplicate of the specified gist under the authenticated user's account, preserving all the original files and content while establishing a relationship between the forked gist and its parent. This operation requires authentication and returns the newly created forked gist object containing its own unique identifier, URLs, and metadata, making it useful for developers who want to build upon or customize existing code snippets shared by others in the GitHub community.
      tags:
      - Forks
      operationId: forkgist
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/gists/gists#fork-a-gist
      parameters:
      - $ref: '#/components/parameters/gist-id'
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/base-gist'
              examples:
                default:
                  $ref: '#/components/examples/base-gist'
          headers:
            Location:
              example: https://api.github.com/gists/aa5a315d61ae9438b18d
              schema:
                type: string
        '304':
          $ref: '#/components/responses/not_modified'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '422':
          $ref: '#/components/responses/validation_failed'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: false
        category: gists
        subcategory: gists
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: '{protocol}://{hostname}/api/v3'
      variables:
        hostname:
          description: Self-hosted Enterprise Server hostname
          default: HOSTNAME
        protocol:
          description: Self-hosted Enterprise Server protocol
          default: http
  /repos/{owner}/{repo}/forks:
    get:
      summary: GitHub List Forks
      description: This API endpoint retrieves a paginated list of all forks for a specified GitHub repository. By making a GET request to /repos/{owner}/{repo}/forks, you can access information about repositories that have been forked from the original repository identified by the owner and repo parameters. The response includes details about each fork such as the fork's owner, creation date, size, and various repository metadata. This endpoint supports pagination through query parameters and can be filtered or sorted based on criteria like newest, oldest, or most starred forks, making it useful for analyzing a repository's reach and derivative projects in the GitHub ecosystem.
      tags:
      - Forks
      operationId: listForks
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/repos/forks#list-forks
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - name: sort
        description: The sort order. `stargazers` will sort by star count.
        in: query
        required: false
        schema:
          type: string
          enum:
          - newest
          - oldest
          - stargazers
          - watchers
          default: newest
        example: newest
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/minimal-repository'
              examples:
                default:
                  $ref: '#/components/examples/minimal-repository-items-2'
          headers:
            Link:
              $ref: '#/components/headers/link'
        '400':
          $ref: '#/components/responses/bad_request'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: repos
        subcategory: forks
      x-api-evangelist-certified: '2025-07-16'
      x-api-naftiko-published: '2025-07-25'
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: GitHub Create Fork
      description: 'Create a fork for the authenticated user.


        **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).


        **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.'
      tags:
      - Forks
      operationId: createFork
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/repos/forks#create-a-fork
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                organization:
                  type: string
                  description: Optional parameter to specify the organization name if forking into an organization.
                name:
                  type: string
                  description: When forking from an existing repository, a new name for the fork.
                default_branch_only:
                  type: boolean
                  description: When forking from an existing repository, fork with only the default branch.
            examples:
              default:
                value:
                  organization: octocat
                  name: Hello-World
                  default_branch_only: true
      responses:
        '202':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/full-repository'
              examples:
                default:
                  $ref: '#/components/examples/full-repository'
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/not_found'
        '422':
          $ref: '#/components/responses/validation_failed'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: repos
        subcategory: forks
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: '{protocol}://{hostname}'
      variables:
        hostname:
          description: Self-hosted Enterprise Server hostname
          default: api.github.com
        protocol:
          description: Self-hosted Enterprise Server protocol
          default: https
  /repos/{owner}/{repo}/merge-upstream:
    post:
      summary: GitHub Sync Fork Branch with the Upstream Repository
      description: Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
      tags:
      - Forks
      operationId: syncForkBranchWithTheUpstreamRepository
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                branch:
                  type: string
                  description: The name of the branch which should be updated to match upstream.
              required:
              - branch
            examples:
              default:
                value:
                  branch: main
      responses:
        '200':
          description: The branch has been successfully synced with the upstream repository
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/merged-upstream'
              examples:
                default:
                  $ref: '#/components/examples/merged-upstream'
        '409':
          description: The branch could not be synced because of a merge conflict
        '422':
          description: The branch could not be synced for some other reason
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: branches
        subcategory: branches
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: '{protocol}://{hostname}'
      variables:
        hostname:
          description: Self-hosted Enterprise Server hostname
          default: api.github.com
        protocol:
          description: Self-hosted Enterprise Server protocol
          default: https
components:
  responses:
    forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
    validation_failed:
      description: Validation failed, or the endpoint has been spammed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/validation-error'
    not_found:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
    not_modified:
      description: Not modified
    bad_request:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/basic-error'
        application/scim+json:
          schema:
            $ref: '#/components/schemas/scim-error'
  schemas:
    simple-user:
      title: Simple User
      description: A GitHub user.
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          example: octocat
        email:
          type:
          - string
          - 'null'
          example: octocat@github.com
        login:
          type: string
          example: octocat
        id:
          type: integer
          example: 1
        node_id:
          type: string
          example: MDQ6VXNlcjE=
        avatar_url:
          type: string
          format: uri
          example: https://github.com/images/error/octocat_happy.gif
        gravatar_id:
          type:
          - string
          - 'null'
          example: 41d064eb2195891e12d0413f63227ea7
        url:
          type: string
          format: uri
          example: https://api.github.com/users/octocat
        html_url:
          type: string
          format: uri
          example: https://github.com/octocat
        followers_url:
          type: string
          format: uri
          example: https://api.github.com/users/octocat/followers
        following_url:
          type: string
          example: https://api.github.com/users/octocat/following{/other_user}
        gists_url:
          type: string
          example: https://api.github.com/users/octocat/gists{/gist_id}
        starred_url:
          type: string
          example: https://api.github.com/users/octocat/starred{/owner}{/repo}
        subscriptions_url:
          type: string
          format: uri
          example: https://api.github.com/users/octocat/subscriptions
        organizations_url:
          type: string
          format: uri
          example: https://api.github.com/users/octocat/orgs
        repos_url:
          type: string
          format: uri
          example: https://api.github.com/users/octocat/repos
        events_url:
          type: string
          example: https://api.github.com/users/octocat/events{/privacy}
        received_events_url:
          type: string
          format: uri
          example: https://api.github.com/users/octocat/received_events
        type:
          type: string
          example: User
        site_admin:
          type: boolean
          example: true
        starred_at:
          type: string
          example: '"2020-07-09T00:17:55Z"'
      required:
      - avatar_url
      - events_url
      - followers_url
      - following_url
      - gists_url
      - gravatar_id
      - html_url
      - id
      - node_id
      - login
      - organizations_url
      - received_events_url
      - repos_url
      - site_admin
      - starred_url
      - subscriptions_url
      - type
      - url
    gist-history:
      title: Gist History
      description: Gist History
      type: object
      properties:
        user:
          $ref: '#/components/schemas/nullable-simple-user'
        version:
          type: string
          example: example_value
        committed_at:
          type: string
          format: date-time
          example: '2026-04-17T12:00:00Z'
        change_status:
          type: object
          properties:
            total:
              type: integer
            additions:
              type: integer
            deletions:
              type: integer
        url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
    gist-simple:
      title: Gist Simple
      description: Gist Simple
      type: object
      properties:
        forks:
          deprecated: true
          type:
          - array
          - 'null'
          items:
            type: object
            properties:
              id:
                type: string
              url:
                type: string
                format: uri
              user:
                $ref: '#/components/schemas/public-user'
              created_at:
                type: string
                format: date-time
              updated_at:
                type: string
                format: date-time
        history:
          deprecated: true
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/gist-history'
        fork_of:
          title: Gist
          description: Gist
          type:
          - object
          - 'null'
          properties:
            url:
              type: string
              format: uri
            forks_url:
              type: string
              format: uri
            commits_url:
              type: string
              format: uri
            id:
              type: string
            node_id:
              type: string
            git_pull_url:
              type: string
              format: uri
            git_push_url:
              type: string
              format: uri
            html_url:
              type: string
              format: uri
            files:
              type: object
              additionalProperties:
                type: object
                properties:
                  filename:
                    type: string
                  type:
                    type: string
                  language:
                    type: string
                  raw_url:
                    type: string
                  size:
                    type: integer
            public:
              type: boolean
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            description:
              type:
              - string
              - 'null'
            comments:
              type: integer
            user:
              $ref: '#/components/schemas/nullable-simple-user'
            comments_url:
              type: string
              format: uri
            owner:
              $ref: '#/components/schemas/nullable-simple-user'
            truncated:
              type: boolean
            forks:
              type: array
              items: {}
            history:
              type: array
              items: {}
          required:
          - id
          - node_id
          - url
          - forks_url
          - commits_url
          - git_pull_url
          - git_push_url
          - html_url
          - comments_url
          - public
          - description
          - comments
          - user
          - files
          - created_at
          - updated_at
        url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        forks_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        commits_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        id:
          type: string
          example: '12345678'
        node_id:
          type: string
          example: '12345678'
        git_pull_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        git_push_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        html_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        files:
          type: object
          additionalProperties:
            type:
            - object
            - 'null'
            properties:
              filename:
                type: string
              type:
                type: string
              language:
                type: string
              raw_url:
                type: string
              size:
                type: integer
              truncated:
                type: boolean
              content:
                type: string
        public:
          type: boolean
          example: true
        created_at:
          type: string
          example: '2026-04-17T12:00:00Z'
        updated_at:
          type: string
          example: '2026-04-17T12:00:00Z'
        description:
          type:
          - string
          - 'null'
          example: This is an example repository
        comments:
          type: integer
          example: 42
        user:
          type:
          - string
          - 'null'
          example: example_value
        comments_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        owner:
          $ref: '#/components/schemas/simple-user'
        truncated:
          type: boolean
    public-user:
      title: Public User
      description: Public User
      type: object
      properties:
        login:
          type: string
          example: octocat
        id:
          type: integer
          example: 42
        node_id:
          type: string
          example: '12345678'
        avatar_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        gravatar_id:
          type:
          - string
          - 'null'
          example: '12345678'
        url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        html_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        followers_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        following_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        gists_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        starred_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        subscriptions_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        organizations_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        repos_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        events_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        received_events_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        type:
          type: string
          example: User
        site_admin:
          type: boolean
          example: true
        name:
          type:
          - string
          - 'null'
          example: octocat
        company:
          type:
          - string
          - 'null'
          example: example_value
        blog:
          type:
          - string
          - 'null'
        location:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
          format: email
        hireable:
          type:
          - boolean
          - 'null'
        bio:
          type:
          - string
          - 'null'
        twitter_username:
          type:
          - string
          - 'null'
        public_repos:
          type: integer
        public_gists:
          type: integer
        followers:
          type: integer
        following:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        plan:
          type: object
          properties:
            collaborators:
              type: integer
            name:
              type: string
            space:
              type: integer
            private_repos:
              type: integer
          required:
          - collaborators
          - name
          - space
          - private_repos
        suspended_at:
          type:
          - string
          - 'null'
          format: date-time
        private_gists:
          type: integer
          example: 1
        total_private_repos:
          type: integer
          example: 2
        owned_private_repos:
          type: integer
          example: 2
        disk_usage:
          type: integer
          example: 1
        collaborators:
          type: integer
          example: 3
      required:
      - avatar_url
      - events_url
      - followers_url
      - following_url
      - gists_url
      - gravatar_id
      - html_url
      - id
      - node_id
      - login
      - organizations_url
      - received_events_url
      - repos_url
      - site_admin
      - starred_url
      - subscriptions_url
      - type
      - url
      - bio
      - blog
      - company
      - email
      - followers
      - following
      - hireable
      - location
      - name
      - public_gists
      - public_repos
      - created_at
      - updated_at
      additionalProperties: false
    basic-error:
      title: Basic Error
      description: Basic Error
      type: object
      properties:
        message:
          type: string
          example: Example body text
        documentation_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        status:
          type: string
          example: open
    base-gist:
      title: Base Gist
      description: Base Gist
      type: object
      properties:
        url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        forks_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        commits_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        id:
          type: string
          example: '12345678'
        node_id:
          type: string
          example: '12345678'
        git_pull_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        git_push_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        html_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        files:
          type: object
          additionalProperties:
            type: object
            properties:
              filename:
                type: string
              type:
                type: string
              language:
                type: string
              raw_url:
                type: string
              size:
                type: integer
        public:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
          example: '2026-04-17T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-04-17T12:00:00Z'
        description:
          type:
          - string
          - 'null'
          example: This is an example repository
        comments:
          type: integer
          example: 42
        user:
          $ref: '#/components/schemas/nullable-simple-user'
        comments_url:
          type: string
          format: uri
          example: https://api.github.com/repos/octocat/Hello-World
        owner:
          $ref: '#/components/schemas/simple-user'
        truncated:
          type: boolean
          example: true
        forks:
          type: array
          items: {}
        history:
          type: array
          items: {}
      required:
      - id
      - node_id
      - url
      - forks_url
      - commits_url
      - git_pull_url
      - git_push_url
      - html_url
      - comments_url
      - public
      - description
      - comments
      - user
      - files
      - created_at
      - updated_at
    validation-error:
      title: Validation Error
      description: Validation Error
      type: object
      required:
      - message
      - documentation_url
      properties:
        message:
          type: string
          example: Example body text
        documentation_url:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
        errors:
          type: array
          items:
            type: object
            required:
            - code
            properties:
              resource:
                type: string
              field:
                type: string
              message:
                type: string
              code:
                type: string
              index:
                type: integer
              value:
                oneOf:
                - type:
                  - string
                  - 'null'
                - type:
                  - integer
                  - 'null'
                - type:
                  - array
                  - 'null'
                  items:
                    type: string
    nullable-simple-user:
      title: Simple User
      description: A GitHub user.
      type:
      - object
      - 'null'
      properties:
        name:
          type:
          - string
          - 'null'
          example: octocat
        email:
          type:
          - string
          - 'null'
          example: octocat@github.com
        login:
          type: string
          example: octocat
        id:
          type: integer
          example: 1
        node_id:
          type: string
          example: MDQ6VXNlcjE=
        avatar_url:
          type: string
          format: uri
          exa

# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-forks-api-openapi.yml