Skip to main content
POST
/
v1
/
notes
/
batch-get-summaries
Batch get note summaries
curl --request POST \
  --url https://api.linda.cedarai.com/v1/notes/batch-get-summaries \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "entities": [
    {
      "entity_id": "<string>",
      "entity_type": "<string>"
    }
  ]
}
'
{
  "summaries": [
    {
      "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
entities
object[]

Entities to fetch summaries for. The server groups by entity type internally and runs one SQL query per type. No hard cap on the number of entries, but practical limits apply (page sizes of a few hundred entities per request are typical).

Response

A successful response.

summaries
object[]

One summary per entity that has at least one note. Entities with zero notes are omitted from the response — clients should default missing entries to "0 notes" rather than expecting one row per requested entity.