List Access Relationships - Serval Documentation

GET

access-relationships

List Access Relationships

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

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

fetch('https://public.api.serval.com/v2/access-relationships', 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/access-relationships",
  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/access-relationships"

	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/access-relationships")

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>",
      "relationshipType": "ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED",
      "targetId": "<string>",
      "targetType": "ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "subjectType": "ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED",
      "subjectId": "<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	Integration, Resource, Role: `apps:read` Knowledge item: `knowledge:read` Team: `teams:manage`
Team-scoped API key	Integration, Resource, Role: `apps:read` Knowledge item: `knowledge:read` Team: Unsupported
User-based token (OAuth)	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.

Authorizations

Authorization

string

header

required

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

Query Parameters

subjectType

enum<string>

required

The kind of subject to list relationships for.

Available options:

ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_APP_INSTANCE,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_RESOURCE,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_ENTITLEMENT,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_TEAM,

ACCESS_RELATIONSHIP_SUBJECT_TYPE_KNOWLEDGE_ITEM

subjectId

string

required

The ID of the subject (app_instance_id | resource_id | entitlement_id | team_id), disambiguated by subject_type.

targetId

string

Filter by target ID (user or group ID).

targetType

enum<string> | null

Filter by target type.

Available options:

ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_TARGET_TYPE_USER,

ACCESS_RELATIONSHIP_TARGET_TYPE_GROUP

relationshipType

enum<string> | null

Filter by relationship type.

Available options:

ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED,

ACCESS_RELATIONSHIP_TYPE_OWNER

pageSize

integer<int32>

Maximum number of results to return per page.

pageToken

string

Token for retrieving the next page of results.

Response

200 - application/json

Success

data

AccessRelationship · object[]

The list of access relationships.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

List Access Relationships

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

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

fetch('https://public.api.serval.com/v2/access-relationships', 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/access-relationships",
  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/access-relationships"

	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/access-relationships")

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>",
      "relationshipType": "ACCESS_RELATIONSHIP_TYPE_UNSPECIFIED",
      "targetId": "<string>",
      "targetType": "ACCESS_RELATIONSHIP_TARGET_TYPE_UNSPECIFIED",
      "createdAt": "2025-01-15T01:30:15.000Z",
      "subjectType": "ACCESS_RELATIONSHIP_SUBJECT_TYPE_UNSPECIFIED",
      "subjectId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

​Authentication and permissions

Authorizations

Query Parameters

Response

Authentication and permissions