GET

/

catalog

/

labels

/

List labels

curl --request GET \
  --url https://api.example.com/catalog/labels/

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/catalog/labels/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/catalog/labels/"

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

	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://api.example.com/catalog/labels/")

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

request = Net::HTTP::Get.new(url)

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

{}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}

Response

Registry of [Label]s, keyed by id.

Holds the authoritative definitions (localized names + descriptions) for a run. A [LabelRef] carried on a detection or entity is resolved back to its full [Label] with get [blocked].

Registry of [Label]s, keyed by id.

Holds the authoritative definitions (localized names + descriptions) for a run. A [LabelRef] carried on a detection or entity is resolved back to its full [Label] with get [blocked].

{key}

object

Kind of sensitive information: a stable id [blocked], per-language [LabelLocale]s, an optional category [blocked], and zero or more tags.

Identity

Labels are identified by id [blocked] — a stable lowercase snake_case string ("phone_number"), never localized, and the catalog key that a [LabelRef] resolves through. Selectors match by id. Derived equality is structural: two labels with the same id but different localizations or tags are not ==; compare id [blocked] for identity.

Localization

The display name and description are localized per [LanguageTag]. English ("en") is required at construction and is the fallback when a requested locale is absent, so localization [blocked] always returns some text — NER and LLM read the analysis language's name and description to prompt the model, keyed by the stable id.

Category and tags

category [blocked] is the single coarse group a label belongs to (financial, health, identity, …), for organizing detected entities by kind. Built-in labels ship with one; a custom label has none unless set.

tags [blocked] is a free-form list of cross-cutting markers a policy selector matches against — sensitivity flags a label may carry several of (pii, phi, pci, sad, secret). Distinct from the category: a label has at most one category but any number of tags. Custom labels can ship with zero of either.

Show child attributes

List labels

curl --request GET \
  --url https://api.example.com/catalog/labels/

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/catalog/labels/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://api.example.com/catalog/labels/"

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

	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://api.example.com/catalog/labels/")

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

request = Net::HTTP::Get.new(url)

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

{}

{
  "message": "<string>",
  "name": "<string>",
  "resource": "<string>",
  "suggestion": "<string>",
  "validation": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>",
      "params": {}
    }
  ]
}