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

# Get GitHub setting

> <p> Gets the setting (schedule, repository, etc.) for GitHub data sources. </p> <p> Required roles: All </p>




## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/qaip/openapi.documented.yml get /github-settings/{id}
openapi: 3.0.3
info:
  title: QAIP APIs
  version: 1.0.0
servers:
  - url: https://developer.qaip.com/api/v1
    description: API base path
security:
  - ApiKeyAuth: []
tags:
  - name: completions
    description: Generate completions
  - name: search
    description: Search content
  - name: extract
    description: Data extraction using LLM
  - name: tags
    description: List available tags
  - name: agent
    description: (Experimental) Agent operations
  - name: tag-source-groups
    description: Tag and source group associations
  - name: source-groups
    description: Source group (job) management and metadata
  - name: sources
    description: Sources management and metadata
  - name: local-file-groups
    description: Local file group management
  - name: secrets
    description: Secret management
  - name: google-drives
    description: Google Drive data source management
  - name: google-drive-settings
    description: Google Drive data source setting management
  - name: crawls
    description: Web crawl data source management
  - name: crawl-settings
    description: Web crawl setting management
  - name: githubs
    description: GitHub data source management
  - name: github-settings
    description: GitHub data source setting management
  - name: notions
    description: Notion data source management
  - name: notion-settings
    description: Notion data source setting management
  - name: authz-subject-attributes
    description: Authorization subject attribute management (admin only)
paths:
  /github-settings/{id}:
    get:
      tags:
        - github-settings
      summary: Get GitHub setting
      description: >
        <p> Gets the setting (schedule, repository, etc.) for GitHub data
        sources. </p> <p> Required roles: All </p>
      operationId: getGitHubSetting
      parameters:
        - name: id
          in: path
          required: true
          description: Ingestion setting ID for the GitHub data source
          schema:
            type: string
      responses:
        '200':
          description: Successful retrieval of GitHub setting
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitHubSetting'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: Python
          source: |-
            import os
            from qaip import Qaip

            client = Qaip(
                api_key=os.environ.get("QAIP_API_KEY"),  # This is the default and can be omitted
            )
            github_setting = client.githubs.retrieve_setting(
                "id",
            )
            print(github_setting.id)
components:
  schemas:
    GitHubSetting:
      type: object
      required:
        - id
        - name
        - repository
      properties:
        id:
          type: string
          description: GitHub ingestion setting ID
        name:
          type: string
          description: Name of the GitHub ingestion setting
        repository:
          type: string
          description: GitHub repository in owner/repo format (e.g. "octocat/Hello-World")
        path_filters:
          type: array
          items:
            type: string
        reference_type:
          $ref: '#/components/schemas/GitHubReferenceType'
        reference_param:
          type: string
          description: Reference parameter (branch name, tag name, or commit hash)
        rrule:
          type: string
          description: Recurrence rule (RFC 5545 RRULE)
        secret_id:
          type: string
          description: ID of the associated secret
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              description: Human-readable error message
            type:
              type: string
              description: Machine-readable error code
    GitHubReferenceType:
      type: string
      description: Git reference type
      enum:
        - default
        - branch
        - tag
        - commit
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication

````