JavaScript SDK
const annotatedFileId = 1;
const limitOne = await client.annotations.list({
limit: 1,
filter: {
annotatedResourceType: 'file',
annotatedResourceIds: [{ id: 1 }],
},
});from cognite.client.data_classes import AnnotationFilter
flt = AnnotationFilter(annotated_resource_type="file", annotated_resource_ids=[{"id": 123}])
res = client.annotations.list(flt, limit=None)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"annotatedResourceType": "file",
"annotatedResourceIds": [
{
"id": 1066
},
{
"id": 1067
}
],
"status": "approved",
"data": {
"label": "cat"
}
},
"cursor": "MzE1NjAwMDcxNzQ0ODI5",
"limit": 25
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'annotatedResourceType' => 'file',
'annotatedResourceIds' => [
[
'id' => 1066
],
[
'id' => 1067
]
],
'status' => 'approved',
'data' => [
'label' => 'cat'
]
],
'cursor' => 'MzE1NjAwMDcxNzQ0ODI5',
'limit' => 25
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list"
payload := strings.NewReader("{\n \"filter\": {\n \"annotatedResourceType\": \"file\",\n \"annotatedResourceIds\": [\n {\n \"id\": 1066\n },\n {\n \"id\": 1067\n }\n ],\n \"status\": \"approved\",\n \"data\": {\n \"label\": \"cat\"\n }\n },\n \"cursor\": \"MzE1NjAwMDcxNzQ0ODI5\",\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"annotatedResourceType\": \"file\",\n \"annotatedResourceIds\": [\n {\n \"id\": 1066\n },\n {\n \"id\": 1067\n }\n ],\n \"status\": \"approved\",\n \"data\": {\n \"label\": \"cat\"\n }\n },\n \"cursor\": \"MzE1NjAwMDcxNzQ0ODI5\",\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"annotatedResourceType\": \"file\",\n \"annotatedResourceIds\": [\n {\n \"id\": 1066\n },\n {\n \"id\": 1067\n }\n ],\n \"status\": \"approved\",\n \"data\": {\n \"label\": \"cat\"\n }\n },\n \"cursor\": \"MzE1NjAwMDcxNzQ0ODI5\",\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 4096,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"annotatedResourceType": "file",
"annotatedResourceId": 1337,
"annotationType": "pointcloud.BoundingVolume",
"creatingApp": "cognite-vision",
"creatingAppVersion": "1.2.1",
"creatingUser": "john.doe@cognite.com",
"data": {
"assetRef": {
"externalId": "abc"
}
},
"status": "approved"
}
],
"nextCursor": null
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Filter annotations
Lists the annotations the caller has access to, based on a filter.
The caller must have read-access on the annotated resources listed in the filter, otherwise the call will fail.
POST
/
annotations
/
list
JavaScript SDK
const annotatedFileId = 1;
const limitOne = await client.annotations.list({
limit: 1,
filter: {
annotatedResourceType: 'file',
annotatedResourceIds: [{ id: 1 }],
},
});from cognite.client.data_classes import AnnotationFilter
flt = AnnotationFilter(annotated_resource_type="file", annotated_resource_ids=[{"id": 123}])
res = client.annotations.list(flt, limit=None)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"annotatedResourceType": "file",
"annotatedResourceIds": [
{
"id": 1066
},
{
"id": 1067
}
],
"status": "approved",
"data": {
"label": "cat"
}
},
"cursor": "MzE1NjAwMDcxNzQ0ODI5",
"limit": 25
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'annotatedResourceType' => 'file',
'annotatedResourceIds' => [
[
'id' => 1066
],
[
'id' => 1067
]
],
'status' => 'approved',
'data' => [
'label' => 'cat'
]
],
'cursor' => 'MzE1NjAwMDcxNzQ0ODI5',
'limit' => 25
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list"
payload := strings.NewReader("{\n \"filter\": {\n \"annotatedResourceType\": \"file\",\n \"annotatedResourceIds\": [\n {\n \"id\": 1066\n },\n {\n \"id\": 1067\n }\n ],\n \"status\": \"approved\",\n \"data\": {\n \"label\": \"cat\"\n }\n },\n \"cursor\": \"MzE1NjAwMDcxNzQ0ODI5\",\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"annotatedResourceType\": \"file\",\n \"annotatedResourceIds\": [\n {\n \"id\": 1066\n },\n {\n \"id\": 1067\n }\n ],\n \"status\": \"approved\",\n \"data\": {\n \"label\": \"cat\"\n }\n },\n \"cursor\": \"MzE1NjAwMDcxNzQ0ODI5\",\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/annotations/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"annotatedResourceType\": \"file\",\n \"annotatedResourceIds\": [\n {\n \"id\": 1066\n },\n {\n \"id\": 1067\n }\n ],\n \"status\": \"approved\",\n \"data\": {\n \"label\": \"cat\"\n }\n },\n \"cursor\": \"MzE1NjAwMDcxNzQ0ODI5\",\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 4096,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"annotatedResourceType": "file",
"annotatedResourceId": 1337,
"annotationType": "pointcloud.BoundingVolume",
"creatingApp": "cognite-vision",
"creatingAppVersion": "1.2.1",
"creatingUser": "john.doe@cognite.com",
"data": {
"assetRef": {
"externalId": "abc"
}
},
"status": "approved"
}
],
"nextCursor": null
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Body
application/json
A request specifying the annotation listing behavior
A filter to apply on annotations
Show child attributes
Show child attributes
Example:
{
"annotatedResourceType": "file",
"annotatedResourceIds": [{ "id": 1066 }, { "id": 1067 }],
"status": "approved",
"data": { "label": "cat" }
}
A cursor pointing to another page of results
Required string length:
1 - 255Example:
"MzE1NjAwMDcxNzQ0ODI5"
Required range:
1 <= x <= 1000Last modified on July 10, 2026
Was this page helpful?
⌘I