Get Annotation Tags

Get all tags that have been added to at least one annotation. Requires a role of at least Analyst

GET /projects/{projectId}/annotations/tags

Get Annotation Tags

cURL

curl --request GET \
  --url https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags', 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://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags",
  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: Basic <encoded-value>"
  ],
]);

$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://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{regionAndDomain}.com/api/app/projects/{projectId}/annotations/tags")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

200

[
  {
    "id": 123,
    "name": "<string>",
    "project_id": 123,
    "has_annotations": true
  }
]

{
  "error": "<string>",
  "status": "error"
}

{
  "error": "<string>",
  "status": "error"
}

Authorizations

Authorization · string · header · required

Service Account

Path Parameters

projectId · integer · required

Your project id (eg: 12345)

Response

200

application/json

Success

id · number

name · string

project_id · number

has_annotations · boolean

whether the tag is currently attached to any annotations