Skip to main content
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>"
}
'
{
  "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>",
      "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>"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID the request is scoped to.

Body

application/json
entity_id
string

Host entity ID. Required in default mode; ignored in reverse-lookup mode.

entity_type
string

Host entity to list notes for. Required in default mode; ignored in reverse-lookup mode (see referenced_entity_type below).

page_size
integer<int32>

Page size for cursor pagination. Unset/zero disables paging.

page_token
string

Opaque cursor from a previous response's next_page_token.

referenced_entity_id
string

Pair with referenced_entity_type. See above.

referenced_entity_type
string

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.

next_page_token
string

Opaque cursor for the next page. Empty when there are no more results, or always empty in reverse-lookup mode (which caps at 100 results without paging). Pass back as page_token on the next request.

notes
object[]

Notes for the requested entity in descending chronological order (newest first). Each entry has resolved attachments and references with is_stale populated.