Skip to main content
POST
/
v1
/
notes
/
get-summary
Get note summary for one entity
curl --request POST \
  --url https://api.linda.cedarai.com/v1/notes/get-summary \
  --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>"
}
'
{
  "summary": {
    "entity_id": "<string>",
    "entity_type": "<string>",
    "latest_note": {
      "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"
    },
    "total_count": 123
  }
}

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

Entity ID to summarize.

entity_type
string

Entity type to summarize.

Response

A successful response.

summary
object

One row of summary data for a single entity, returned by GetNoteSummary and BatchGetNoteSummaries. Designed for list-page badges and counters.