Skip to main content
GET
Get one pull request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pullRequestID
string<uuid>
required

Query Parameters

org_id
string<uuid>

The pull request's owning organization to act in: the org_id the PullRequest carries. Required when more than one of the caller's organizations owns the pull request.

Response

OK

additions
integer<int64>
required
Required range: x >= 0
checks_failed
integer<int64>
required
Required range: x >= 0
checks_passed
integer<int64>
required
Required range: x >= 0
checks_total
integer<int64>
required
Required range: x >= 0
comment_count
integer<int64> | null
required
Required range: x >= 0
deletions
integer<int64>
required
Required range: x >= 0
dispatch_target
enum<string>
required
Available options:
author_task,
review_run,
none
draft
boolean
required
github_updated_at
string<date-time>
required
html_url
string
required
latest_created_at
string<date-time>
required
needs_attention
boolean
required
org_id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
pr_number
integer<int64>
required
Required range: x >= 1
pull_request_id
string<uuid>
required
ready_for_merge
boolean
required
repo_name
string
required
repo_owner
string
required
review_runs
object[]
required
section
enum<string>
required
Available options:
in_review,
approved,
other
title
string
required
viewer_standing
enum<string>
required
Available options:
author,
pending,
approved,
changes_requested,
commented,
dismissed,
none
author_login
string
Minimum string length: 1
base_branch
string
base_sha
string
Pattern: ^[0-9a-f]{40}$
ci_status
enum<string>
Available options:
pending,
passed,
failed
guide_outline
object[]
Required array length: 1 - 50 elements
head_branch
string
head_sha
string
merged_at
string<date-time>
origin_task
object
pr_state
enum<string>
Available options:
open,
closed,
merged
severity_counts
object
stack_children
object[]
Minimum array length: 1
stack_parent
object

One tracked open pull request on a branch-chain edge: as stack_parent, the pull request whose head repository and branch match this pull request's base; as an element of stack_children, a pull request whose base branch is this pull request's head. Present only when the edge exists in Aether's tracked pull-request projection; absence does not prove the pull request is unstacked.

summary_severity
enum<string>
Available options:
p1,
p2,
nit
verdict
enum<string>
Available options:
approve,
request_changes,
comment,
dismissed,
superseded