Notes API
List notes
Returns notes on a given entity in descending chronological order (newest first). Supports cursor-based pagination via page_size and page_token. When both referenced_entity_type and referenced_entity_id are set, the request switches to reverse-lookup mode (notes mentioning the given entity), capped at 100 results without pagination.
POST
/
v1
/
notes
/
list
List notes
curl --request POST \
--url https://api.linda.cedarai.com/v1/notes/list \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"entity_id": "<string>",
"entity_type": "<string>",
"page_size": 123,
"page_token": "<string>",
"referenced_entity_id": "<string>",
"referenced_entity_type": "<string>"
}
'import requests
url = "https://api.linda.cedarai.com/v1/notes/list"
payload = {
"entity_id": "<string>",
"entity_type": "<string>",
"page_size": 123,
"page_token": "<string>",
"referenced_entity_id": "<string>",
"referenced_entity_type": "<string>"
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity_id: '<string>',
entity_type: '<string>',
page_size: 123,
page_token: '<string>',
referenced_entity_id: '<string>',
referenced_entity_type: '<string>'
})
};
fetch('https://api.linda.cedarai.com/v1/notes/list', 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://api.linda.cedarai.com/v1/notes/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([
'entity_id' => '<string>',
'entity_type' => '<string>',
'page_size' => 123,
'page_token' => '<string>',
'referenced_entity_id' => '<string>',
'referenced_entity_type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$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://api.linda.cedarai.com/v1/notes/list"
payload := strings.NewReader("{\n \"entity_id\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_size\": 123,\n \"page_token\": \"<string>\",\n \"referenced_entity_id\": \"<string>\",\n \"referenced_entity_type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
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://api.linda.cedarai.com/v1/notes/list")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_id\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_size\": 123,\n \"page_token\": \"<string>\",\n \"referenced_entity_id\": \"<string>\",\n \"referenced_entity_type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linda.cedarai.com/v1/notes/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_id\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_size\": 123,\n \"page_token\": \"<string>\",\n \"referenced_entity_id\": \"<string>\",\n \"referenced_entity_type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"next_page_token": "<string>",
"notes": [
{
"attachments": [
{
"attachment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"media_type": "<string>",
"note_id": "<string>",
"size_bytes": "<string>",
"url": "<string>"
}
],
"content": "<string>",
"content_redacted": true,
"created_at": "2023-11-07T05:31:56Z",
"created_by_name": "<string>",
"created_by_uuid": "<string>",
"entity_id": "<string>",
"entity_type": "<string>",
"note_id": "<string>",
"references": [
{
"display_text": "<string>",
"entity_id": "<string>",
"entity_type": "<string>",
"is_stale": true,
"url": "<string>"
}
],
"sharing": {
"mode": "ALL_PARTIES",
"parties": [
{
"display_name": "<string>",
"party_id": "<string>",
"party_type": "<string>"
}
]
},
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Body
application/json
Reverse-lookup mode: when both referenced_entity_type and
referenced_entity_id are set, returns notes whose references
include this (entity_type, entity_id) pair — i.e. notes that
mentioned this entity via <<ref:...>>. Hard-capped at 100 results,
pagination is disabled in this mode.
Example: to list every note that mentions equipment 54321:
{
"referenced_entity_type": "equipment",
"referenced_entity_id": "54321"
}
Response
A successful response.
Was this page helpful?
⌘I
List notes
curl --request POST \
--url https://api.linda.cedarai.com/v1/notes/list \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"entity_id": "<string>",
"entity_type": "<string>",
"page_size": 123,
"page_token": "<string>",
"referenced_entity_id": "<string>",
"referenced_entity_type": "<string>"
}
'import requests
url = "https://api.linda.cedarai.com/v1/notes/list"
payload = {
"entity_id": "<string>",
"entity_type": "<string>",
"page_size": 123,
"page_token": "<string>",
"referenced_entity_id": "<string>",
"referenced_entity_type": "<string>"
}
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity_id: '<string>',
entity_type: '<string>',
page_size: 123,
page_token: '<string>',
referenced_entity_id: '<string>',
referenced_entity_type: '<string>'
})
};
fetch('https://api.linda.cedarai.com/v1/notes/list', 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://api.linda.cedarai.com/v1/notes/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([
'entity_id' => '<string>',
'entity_type' => '<string>',
'page_size' => 123,
'page_token' => '<string>',
'referenced_entity_id' => '<string>',
'referenced_entity_type' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"Content-Type: application/json",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <api-key>"
],
]);
$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://api.linda.cedarai.com/v1/notes/list"
payload := strings.NewReader("{\n \"entity_id\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_size\": 123,\n \"page_token\": \"<string>\",\n \"referenced_entity_id\": \"<string>\",\n \"referenced_entity_type\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
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://api.linda.cedarai.com/v1/notes/list")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_id\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_size\": 123,\n \"page_token\": \"<string>\",\n \"referenced_entity_id\": \"<string>\",\n \"referenced_entity_type\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linda.cedarai.com/v1/notes/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_id\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_size\": 123,\n \"page_token\": \"<string>\",\n \"referenced_entity_id\": \"<string>\",\n \"referenced_entity_type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"next_page_token": "<string>",
"notes": [
{
"attachments": [
{
"attachment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"media_type": "<string>",
"note_id": "<string>",
"size_bytes": "<string>",
"url": "<string>"
}
],
"content": "<string>",
"content_redacted": true,
"created_at": "2023-11-07T05:31:56Z",
"created_by_name": "<string>",
"created_by_uuid": "<string>",
"entity_id": "<string>",
"entity_type": "<string>",
"note_id": "<string>",
"references": [
{
"display_text": "<string>",
"entity_id": "<string>",
"entity_type": "<string>",
"is_stale": true,
"url": "<string>"
}
],
"sharing": {
"mode": "ALL_PARTIES",
"parties": [
{
"display_name": "<string>",
"party_id": "<string>",
"party_type": "<string>"
}
]
},
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}