Review API
Get Review
Read a review’s source, apply state, approval requirement, and promotion CI context. CI includes the latest attempt, failure messages, execution IDs, current enforcement, and source/target policies when the caller can read them. Approval and CI results are independent of apply status.
GET
Get Review
Authentication and permissions
Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.
CI policy details are independently authorized for each workspace. API keys additionally need sdlc-settings:write on that workspace; user OAuth requires permission to view its settings. Otherwise that policy is marked unavailable while the review and CI results remain readable.
- API key: The key must allow the session’s workspace, or either the source or target workspace of a promotion. The review’s target workspace must belong to your organization.
- User: session review: Requires permission to view configuration sessions in the session’s workspace.
- User: promotion: Requires review or apply permission on the target workspace, or both staging permission on the target workspace and author permission on the source workspace. Cross-organization access from the source workspace requires an active workspace link between organizations in the same Parent Organization.
- User: parent-to-branch pull: For a recorded parent-to-branch pull, staging permission on the target branch and branch permission on the source parent also authorize access.

