Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Response

Current settings.

Per-organization automatic PR review configuration. PATCH is a partial update: omitted fields keep their current values.

exclude_bots
boolean

Skip PRs opened by bot authors.

excluded_authors
string[]

Author logins to exclude from automatic review.

Maximum array length: 500
reviewed_bots
string[]

Bot logins to review despite exclude_bots.

Maximum array length: 200
review_on_push
boolean

Re-review when new commits are pushed.

allow_overage
boolean

Permit reviews beyond the plan limit.

overage_review_cap
integer | null

Maximum reviews when overage is allowed; null for uncapped.

Required range: x >= 51
block_on_findings
boolean

When true (default), a review whose findings include a severity in blocking_severities submits a blocking review (GitHub REQUEST_CHANGES / failed status). When false, findings never block.

blocking_severities
enum<string>[]

Finding severities that trigger a blocking review when block_on_findings is enabled. Defaults to critical and high.

Maximum array length: 4
Available options:
critical,
high,
medium,
low
approve_clean_prs
boolean

When true, submit a GitHub approval on a clean PR instead of a silent commit-status-only pass.

target_branches
string[]

Branch-name patterns (single * wildcard, case-insensitive) restricting automatic reviews to PRs whose base/target branch matches. Empty array reviews all branches.

Maximum array length: 100