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

# Get PR review settings

> Read how PR reviews behave across your organization.

Returns the PR review settings configured for your organization under **Settings** in Hacktron:

* `scm_comments_enabled`: reviews post comments and finding details on pull and merge requests.
* `scm_system_comments_enabled`: reviews also post system comments, such as skipped reviews, usage limits and configuration warnings.
* `fail_on_severity`: the severity at or above which a finding fails the PR check, or `null` when it never fails.
* `scan_include_*` and `scan_exclude_*`: which pull requests are reviewed, by target branch, label, author and title keyword. `null` means no filter.

A repository's [`.hacktron/config.yaml`](https://docs.hacktron.ai/code-review/config) takes precedence over these defaults. To check whether reviews are enabled for a repository, read its `prScansEnabled` value from [List repositories](https://docs.hacktron.ai/api-reference/repos/list-repos.md).

> [!NOTE]
>
> **Scope required**: `read`


## OpenAPI

````yaml GET /pr-review-settings
openapi: 3.0.0
info:
  title: Hacktron REST API
  description: Public REST API for programmatic access to Hacktron
  version: '1.0'
  contact: {}
servers:
  - url: https://api.hacktron.ai/v1
security:
  - api-key: []
tags: []
paths:
  /pr-review-settings:
    get:
      tags:
        - REST API - Repos
      summary: >-
        Get the organization's PR/MR review settings: whether reviews post
        comments, the severity that fails the PR check, and which PRs are
        reviewed
      operationId: RestPrReviewSettingsController_get
      parameters:
        - name: X-Organization-Id
          in: header
          description: Organization ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestPrReviewSettingsDto'
components:
  schemas:
    RestPrReviewSettingsDto:
      type: object
      properties:
        scm_comments_enabled:
          type: boolean
          description: >-
            Whether Hacktron publishes comments and finding details to connected
            source control pull and merge requests
        scm_system_comments_enabled:
          type: boolean
          description: >-
            Whether Hacktron posts system comments such as skipped reviews,
            usage limits, and configuration warnings. Defaults to true. Requires
            scm_comments_enabled.
        fail_on_severity:
          type: string
          description: >-
            Org-wide default fail_on severity threshold for PR/MR checks. A
            repo's .hacktron/config.yaml fail_on.severity overrides this. Send
            null to disable.
          enum:
            - critical
            - high
            - medium
            - low
            - info
          nullable: true
        scan_include_branches:
          description: >-
            Org-wide default target branch patterns to scan PRs/MRs for (null =
            all branches). Glob patterns (`*`, `**`, `?`, `{a,b}`),
            case-insensitive. A repo's .hacktron/config.yaml include.branches
            overrides this.
          example:
            - main
            - '**/release/**'
          nullable: true
          type: array
          items:
            type: string
        scan_exclude_branches:
          description: >-
            Org-wide default target branch patterns to exclude from PR/MR scans
            (null = none). Takes precedence over scan_include_branches. A repo's
            .hacktron/config.yaml exclude.branches overrides this.
          example:
            - '**/release/legacy/**'
          nullable: true
          type: array
          items:
            type: string
        scan_include_labels:
          description: >-
            Org-wide default labels to require on PRs/MRs for scanning (null =
            any). A repo's .hacktron/config.yaml include.labels overrides this.
          example:
            - feature
            - bugfix
          nullable: true
          type: array
          items:
            type: string
        scan_exclude_labels:
          description: >-
            Org-wide default labels to exclude PR/MR scans for (null = none).
            Takes precedence over scan_include_labels. A repo's
            .hacktron/config.yaml exclude.labels overrides this.
          example:
            - wip
            - no-scan
          nullable: true
          type: array
          items:
            type: string
        scan_include_authors:
          description: >-
            Org-wide default author patterns to require on PRs/MRs for scanning
            (null = any). Glob patterns (`*`, `**`, `?`, `{a,b}`),
            case-insensitive. A repo's .hacktron/config.yaml include.authors
            overrides this.
          example:
            - alice
            - bob
          nullable: true
          type: array
          items:
            type: string
        scan_exclude_authors:
          description: >-
            Org-wide default author patterns to exclude PR/MR scans for (null =
            none). Glob patterns (`*`, `**`, `?`, `{a,b}`), case-insensitive.
            Takes precedence over scan_include_authors. A repo's
            .hacktron/config.yaml exclude.authors overrides this.
          example:
            - dependabot[bot]
            - renovate[bot]
            - '*-bot'
          nullable: true
          type: array
          items:
            type: string
        scan_include_keywords:
          description: >-
            Org-wide default title keywords to require on PRs/MRs for scanning
            (null = any). Case-insensitive substring match. A repo's
            .hacktron/config.yaml include.keywords overrides this.
          example:
            - release
            - security
          nullable: true
          type: array
          items:
            type: string
        scan_exclude_keywords:
          description: >-
            Org-wide default title keywords to exclude PR/MR scans for (null =
            none). Case-insensitive substring match. A repo's
            .hacktron/config.yaml exclude.keywords overrides this.
          example:
            - '[exclude hacktron]'
            - wip
          nullable: true
          type: array
          items:
            type: string
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-Api-Key

````

## Related topics

- [Update PR review settings](https://docs.hacktron.ai/api-reference/repos/update-pr-review-settings.md)
- [Get Started](https://docs.hacktron.ai/mcp/get-started.md)
- [Organization settings](https://docs.hacktron.ai/platform/organization-settings.md)
- [Hacktron in Slack](https://docs.hacktron.ai/platform/slack-assistant.md)
- [Code Review](https://docs.hacktron.ai/code-review/overview.md)


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