Skip to main content
GET
List Review Comments

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. Comments are readable only when the review’s workspace belongs to your organization. Threads on items you cannot view are omitted, and their replies are denied.
  • 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.
  • 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.

Authorizations

Authorization
string
header
required

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

Path Parameters

review_id
string
required
thread_id
string
required

Query Parameters

pageSize
integer<int32>

Defaults to 20; maximum 100.

pageToken
string

A thread's comments_next_page_token or the previous next_page_token.

Response

200 - application/json

Success

data
ReviewComment · object[]
nextPageToken
string