Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
{entityType}
/
{entityId}
/
notes
/
{noteId}
Get Note
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/notes/{noteId} \
  --header 'Authorization: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440003",
  "entityId": "550e8400-e29b-41d4-a716-446655440001",
  "entityType": "events",
  "text": "Adjuster contacted claimant and scheduled inspection for Monday.",
  "author": {
    "id": "550e8400-e29b-41d4-a716-446655440010",
    "name": "John Smith",
    "email": "[email protected]"
  },
  "authorName": "John Smith",
  "isPrivileged": false,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": null
}

Authorizations

​
Authorization
string
header
required

Use format: ApiKey <your-api-key>

Path Parameters

​
companyId
string<uuid>
required

Company identifier

​
entityType
enum<string>
required

The type of entity (events, policies, or insureds) The type of entity the note is attached to

Available options:
events,
policies,
insureds
​
entityId
string<uuid>
required

The ID of the entity

​
noteId
string<uuid>
required

Note identifier

Response

Note details

A note attached to an entity (event, policy, or insured)

​
id
string<uuid>
​
entityId
string<uuid>

The ID of the entity this note is attached to

​
entityType
enum<string>

The type of entity the note is attached to

Available options:
events,
policies,
insureds
​
text
string

The note content

​
author
object

User details when the note has a linked user (null for notes created with authorName)

​
authorName
string

Display name for the author. Uses user's name if author is linked, otherwise the stored authorName, or "UNKNOWN" if neither.

​
isPrivileged
boolean

Whether this is a privileged note (only visible with privileged_notes:read permission)

​
createdAt
string<date-time>

When the note was created (ISO 8601)

​
updatedAt
string<date-time> | null

When the note was last updated (ISO 8601), or null if never updated