List Subject Tags - Serval Documentation

GET

tags

for-subject

List Subject Tags

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

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

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

	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/tags/for-subject")

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>",
      "name": "<string>",
      "color": "<string>",
      "iconSlug": "<string>",
      "teamId": "<string>",
      "description": "<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	Resource tags, Role tags, Integration tags: `apps:read` Form tags, Form Block tags, Workflow or skill tags: `settings:read`
Team-scoped API key	Resource tags, Role tags, Integration tags: `apps:read` Form tags, Form Block tags, Workflow or skill tags: `settings:read`
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. Authorization follows the tagged subject. Granting permission to edit tag definitions alone does not authorize editing every tagged resource.

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

TagSubjectType is the kind of entity a tag is attached to. Mirrors the DB tag_subject_type enum and keys the polymorphic tag-subject RPCs that replace the per-subject tag-attach RPCs.

Deliberately distinct from AccessRelationshipSubjectType: the two overlap but diverge (tags add workflow/guidance; owners add team) and back separate DB enums. Unifying them would trade enum type-safety for runtime subset validation.

Available options:

TAG_SUBJECT_TYPE_UNSPECIFIED,

TAG_SUBJECT_TYPE_WORKFLOW,

TAG_SUBJECT_TYPE_GUIDANCE,

TAG_SUBJECT_TYPE_APP_INSTANCE,

TAG_SUBJECT_TYPE_RESOURCE,

TAG_SUBJECT_TYPE_ENTITLEMENT,

TAG_SUBJECT_TYPE_FORM,

TAG_SUBJECT_TYPE_FORM_BLOCK

subjectId

string

required

pageSize

integer<int32>

Maximum number of results to return. Default is 10000, maximum is 10000.

pageToken

string

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data

Tag · object[]

Show child attributes

nextPageToken

string | null

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

List Subject Tags

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

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

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

	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/tags/for-subject")

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>",
      "name": "<string>",
      "color": "<string>",
      "iconSlug": "<string>",
      "teamId": "<string>",
      "description": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

​Authentication and permissions

Authorizations

Query Parameters

Response

Authentication and permissions