List Reclamation Candidates - Serval Documentation

GET

teams

{team_id}

reclamation-candidates

List Reclamation Candidates

curl --request GET \
  --url https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates', 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/teams/{team_id}/reclamation-candidates",
  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/teams/{team_id}/reclamation-candidates"

	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/teams/{team_id}/reclamation-candidates")

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>",
      "teamId": "<string>",
      "entitlementId": "<string>",
      "userId": "<string>",
      "appInstanceId": "<string>",
      "resourceType": "<string>",
      "status": "RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "concludedAt": "2025-01-15T01:30:15.000Z",
      "lastLoginAt": "2025-01-15T01:30:15.000Z",
      "decidedByUserId": "<string>"
    }
  ],
  "nextPageToken": "<string>",
  "stats": {
    "reclaimed": 123,
    "dismissed": 123
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

team_id

string

required

Query Parameters

status

enum<string> | null

The lifecycle state of an reclamation-candidate reclamation, derived server-side.

Available options:

RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED,

RECLAMATION_CANDIDATE_STATUS_IN_REVIEW,

RECLAMATION_CANDIDATE_STATUS_RECLAIMING,

RECLAMATION_CANDIDATE_STATUS_REVIEW_DISMISSED,

RECLAMATION_CANDIDATE_STATUS_REVIEW_RECLAIMED,

RECLAMATION_CANDIDATE_STATUS_AUTO_RECLAIMED,

RECLAMATION_CANDIDATE_STATUS_RECLAIM_FAILED

appInstanceIds

string[]

Scope to these app instances (integrations). Empty selects every one.

string

Case-insensitive substring match on the entitlement or resource name.

pageSize

integer<int32>

pageToken

string

Response

200 - application/json

Success

data

ReclamationCandidate · object[]

Show child attributes

nextPageToken

string | null

Cursor for the next page; empty when there are no more results.

stats

stats · object

Team-wide concluded dismiss/reclaim tally, independent of the filters above. Backs the /roles stat widgets.

Show child attributes

List Reclamation Candidates

curl --request GET \
  --url https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates', 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/teams/{team_id}/reclamation-candidates",
  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/teams/{team_id}/reclamation-candidates"

	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/teams/{team_id}/reclamation-candidates")

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>",
      "teamId": "<string>",
      "entitlementId": "<string>",
      "userId": "<string>",
      "appInstanceId": "<string>",
      "resourceType": "<string>",
      "status": "RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "concludedAt": "2025-01-15T01:30:15.000Z",
      "lastLoginAt": "2025-01-15T01:30:15.000Z",
      "decidedByUserId": "<string>"
    }
  ],
  "nextPageToken": "<string>",
  "stats": {
    "reclaimed": 123,
    "dismissed": 123
  }
}