List reviews
Lists the reviews in your inbox, newest first, in a realm or across an organization; by default only pending ones.
Requires a signed-in user token; with realm_id, a realm member (or higher) with the reviews.view permission on that realm; with org_id, a role with the reviews.view permission in that organization. With neither, the results are limited to what you can see.
POST
/
v1
/
reviews
/
get
List reviews
curl --request POST \
--url https://{host}/v1/reviews/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f"
}
'import requests
url = "https://{host}/v1/reviews/get"
payload = { "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({org_id: '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f'})
};
fetch('https://{host}/v1/reviews/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/reviews/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'org_id' => '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/v1/reviews/get"
payload := strings.NewReader("{\n \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/v1/reviews/get")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/reviews/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"items": [
{
"review_id": "4a3b2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d",
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"realm_name": "Production",
"realm_slug": "production",
"org_slug": "acme",
"run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
"run_name": "brave-otter",
"phase": "approve",
"team": "code-review",
"title": "Approve the fix",
"message": "3 findings fixed; approve to merge.",
"review_url": "https://cliqhub.io/reviews/4a3b2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d",
"event": "hug.review_requested",
"requested_at": 1759834500000,
"notification_id": "5b4c3d2e-1f0a-4b9c-8d7e-6f5a4b3c2d1e",
"status": "pending",
"artifact_count": 1,
"resolved_at": null,
"last_reminded_at": null
}
],
"total": 1,
"offset": 0,
"limit": 50,
"type": "array"
}
}{
"ok": false,
"error": {
"code": "unauthorized",
"message": "Authentication required"
}
}{
"ok": false,
"error": {
"code": "forbidden",
"message": "You do not have access to do this"
}
}{
"ok": false,
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"ok": false,
"error": "org_id: org_id is required when listing reviews without realm_id",
"code": "invalid_params"
}{
"ok": false,
"error": "Internal server error",
"code": "internal_error"
}Authorizations
User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).
Body
application/json
Only reviews in this realm.
Organization UUID. Required when listing without realm_id. Never invent from X-Org-Id.
Statuses to include: pending (default), decided, completed, expired.
Page size. Default 50.
Required range:
x >= 1Rows to skip, for paging.
⌘I
List reviews
curl --request POST \
--url https://{host}/v1/reviews/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f"
}
'import requests
url = "https://{host}/v1/reviews/get"
payload = { "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({org_id: '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f'})
};
fetch('https://{host}/v1/reviews/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/reviews/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'org_id' => '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/v1/reviews/get"
payload := strings.NewReader("{\n \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/v1/reviews/get")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/reviews/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"items": [
{
"review_id": "4a3b2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d",
"realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
"realm_name": "Production",
"realm_slug": "production",
"org_slug": "acme",
"run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
"run_name": "brave-otter",
"phase": "approve",
"team": "code-review",
"title": "Approve the fix",
"message": "3 findings fixed; approve to merge.",
"review_url": "https://cliqhub.io/reviews/4a3b2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d",
"event": "hug.review_requested",
"requested_at": 1759834500000,
"notification_id": "5b4c3d2e-1f0a-4b9c-8d7e-6f5a4b3c2d1e",
"status": "pending",
"artifact_count": 1,
"resolved_at": null,
"last_reminded_at": null
}
],
"total": 1,
"offset": 0,
"limit": 50,
"type": "array"
}
}{
"ok": false,
"error": {
"code": "unauthorized",
"message": "Authentication required"
}
}{
"ok": false,
"error": {
"code": "forbidden",
"message": "You do not have access to do this"
}
}{
"ok": false,
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"ok": false,
"error": "org_id: org_id is required when listing reviews without realm_id",
"code": "invalid_params"
}{
"ok": false,
"error": "Internal server error",
"code": "internal_error"
}