> ## Documentation Index
> Fetch the complete documentation index at: https://gecko.security/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the GitHub integration

> Current GitHub App installations for the team, one per organization, with the same connection health the dashboard shows. Never returns credentials.



## OpenAPI

````yaml /api-reference/openapi.json get /integrations/github
openapi: 3.1.0
info:
  title: Gecko Security API
  version: 1.5.0
  description: >-
    Programmatic access to scans, vulnerabilities, repositories, schedules,
    integrations, and scanner image releases. Authenticate with an API key via
    the `X-API-Key` header or `Authorization: Bearer <key>`.
servers:
  - url: https://app.gecko.security/api/v1
security:
  - ApiKeyHeader: []
  - BearerAuth: []
paths:
  /integrations/github:
    get:
      summary: Get the GitHub integration
      description: >-
        Current GitHub App installations for the team, one per organization,
        with the same connection health the dashboard shows. Never returns
        credentials.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitHubIntegration'
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GitHubIntegration:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        object:
          type: string
          const: github_integration
        enabled:
          type: boolean
        installations:
          type: array
          items:
            type: object
            properties:
              installation_id:
                anyOf:
                  - type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  - type: 'null'
              account:
                type: string
              enabled:
                type: boolean
              status:
                type: string
                enum:
                  - ok
                  - outdated
                  - broken
                description: >-
                  `outdated`: an organization owner has not accepted permissions
                  the App now requests. `broken`: GitHub is rejecting the
                  installation (suspended or uninstalled).
              status_reason:
                description: >-
                  Why the status is not `ok`, e.g. "missing permissions: checks:
                  write".
                type:
                  - string
                  - 'null'
              settings_url:
                type:
                  - string
                  - 'null'
              connected_at:
                type: string
            required:
              - installation_id
              - account
              - enabled
              - status
              - status_reason
              - settings_url
              - connected_at
            additionalProperties: false
        tracked_repositories_count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - object
        - enabled
        - installations
        - tracked_repositories_count
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            param:
              type: string
            doc_url:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - doc_url
            - request_id
      required:
        - error
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.