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

# Get the organization's pull-request controls

> Returns the organization layer of the pull-request controls and whether it is locked. An organization that never saved one reads the product defaults, unlocked — the state in which every project answers for itself.



## OpenAPI

````yaml /api-reference/earnie/platform-openapi.json get /v1/organization/pr-feedback
openapi: 3.0.3
info:
  title: Earnie Organization Settings API
  description: >-
    Read your organization, and read or change scan configuration, automatic
    scanning, pull request feedback, and local hook settings.
  version: 1.0.0
servers:
  - url: https://{tenant}.earnie.dev
    description: Your Earnie deployment
    variables:
      tenant:
        default: your-company
        description: >-
          Your organization's Earnie address, as shown in your browser when you
          sign in.
security:
  - bearerAuth: []
paths:
  /v1/organization/pr-feedback:
    get:
      tags:
        - organization
      summary: Get the organization's pull-request controls
      description: >-
        Returns the organization layer of the pull-request controls and whether
        it is locked. An organization that never saved one reads the product
        defaults, unlocked — the state in which every project answers for
        itself.
      operationId: GetV1OrganizationPRFeedback
      responses:
        '200':
          description: The organization's pull-request controls.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgPRFeedbackSettings'
        '401':
          description: Not authenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient permissions (requires scanconfig:read)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    OrgPRFeedbackSettings:
      type: object
      description: >-
        The organization layer of the same pull-request controls, plus the lock
        that decides whether they are advice or law. Unlocked — the default —
        this document is inert: every project answers for itself and these
        values are never consulted. It is deliberately not a set of inherited
        defaults, because that would silently change the behaviour of every
        project that had never saved its own settings. Locked, these values are
        in force for every project in the organization and project-level writes
        are refused. Project settings are left untouched, so unlocking restores
        what each project had chosen.
      required:
        - summary_comment
        - inline_severity_floor
        - inline_comment_cap
        - draft_pull_requests
        - bot_authors
        - base_branch_filter
        - path_filters
        - locked
      properties:
        summary_comment:
          type: string
          enum:
            - always
            - on_failure_only
          description: When the Earnie PR summary comment appears.
        inline_severity_floor:
          type: string
          enum:
            - critical
            - high
            - medium
            - low
            - info
          description: Lowest finding severity eligible for an inline review comment.
        inline_comment_cap:
          type: integer
          minimum: 0
          maximum: 10
          description: Maximum inline comments in one COMMENT review.
        draft_pull_requests:
          type: string
          enum:
            - scan
            - skip
          description: What to do with a draft pull request.
        bot_authors:
          type: string
          enum:
            - scan
            - skip
          description: What to do with a pull request opened by a provider bot account.
        base_branch_filter:
          type: array
          items:
            type: string
          maxItems: 50
          description: Allow-list of base-branch patterns; empty means every base branch.
        path_filters:
          type: array
          items:
            type: string
          maxItems: 50
          description: Allow-list of changed-file patterns; empty means every path.
        locked:
          type: boolean
          description: >-
            Whether these values are in force for every project in the
            organization. False leaves the document inert.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An Earnie API key, sent as `Authorization: Bearer sk_earnie_...`. Create
        one under Settings > API keys. The key's scopes decide which operations
        it may call.

````

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