List Reviews - Serval Documentation

GET

reviews

List Reviews

curl --request GET \
  --url https://public.api.serval.com/v2/reviews \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/reviews', 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://public.api.serval.com/v2/reviews",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/reviews"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/reviews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "createdByUserId": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "closedAt": "2025-01-15T01:30:15.000Z",
      "sourceTeamId": "<string>",
      "targetTeamId": "<string>",
      "origin": "REVIEW_ORIGIN_UNSPECIFIED",
      "session": {
        "sessionId": "<string>",
        "agentId": "<string>"
      },
      "applyStatus": "REVIEW_APPLY_STATUS_UNSPECIFIED",
      "sourceOrgId": "<string>",
      "targetOrgId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	API key: `reviews:read` User: session reviews and incoming promotions, User: outgoing promotions: Unsupported
Team-scoped API key	API key: `reviews:read` User: session reviews and incoming promotions, User: outgoing promotions: Unsupported
User-based token (OAuth)	API key: Unsupported User: session reviews and incoming promotions, User: outgoing promotions: Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

API key: The requested team must be in your organization and allowed by the key. Use outgoing=true for promotions from that team.
User: session reviews and incoming promotions: Requires permission to view configuration sessions in the requested team.
User: outgoing promotions: With outgoing=true, requires permission to author promotions from the requested team.

Authorizations

Authorization

string

header

required

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

Query Parameters

teamId

string

outgoing

boolean

Outgoing promotions from team_id; otherwise reviews owned by team_id.

pageSize

integer<int32>

Defaults to 50; maximum 100.

pageToken

string

Response

200 - application/json

Success

data

Review · object[]

Show child attributes

nextPageToken

string

List Reviews

curl --request GET \
  --url https://public.api.serval.com/v2/reviews \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/reviews', 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://public.api.serval.com/v2/reviews",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/reviews"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/reviews")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "createdByUserId": "<string>",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "closedAt": "2025-01-15T01:30:15.000Z",
      "sourceTeamId": "<string>",
      "targetTeamId": "<string>",
      "origin": "REVIEW_ORIGIN_UNSPECIFIED",
      "session": {
        "sessionId": "<string>",
        "agentId": "<string>"
      },
      "applyStatus": "REVIEW_APPLY_STATUS_UNSPECIFIED",
      "sourceOrgId": "<string>",
      "targetOrgId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

​Authentication and permissions

Authorizations

Query Parameters

Response

Authentication and permissions