Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
{entityType}
/
{entityId}
/
notes
List Notes
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/notes \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "entityId": "550e8400-e29b-41d4-a716-446655440001",
      "entityType": "insureds",
      "text": "Verified coverage details with insured.",
      "author": {
        "id": "550e8400-e29b-41d4-a716-446655440010",
        "name": "John Smith",
        "email": "john@example.com"
      },
      "authorName": "John Smith",
      "isPrivileged": false,
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": null
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "entityId": "550e8400-e29b-41d4-a716-446655440001",
      "entityType": "insureds",
      "text": "Historical note from legacy system.",
      "author": null,
      "authorName": "Jane Doe (External)",
      "isPrivileged": false,
      "createdAt": "2024-06-01T14:00:00.000Z",
      "updatedAt": null
    }
  ],
  "totalCount": 2
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

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

Query Parameters

​
page
integer
default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1
​
sortBy
enum<string>
default:createdAt

Field to sort by (default createdAt)

Available options:
createdAt,
updatedAt
​
sortDirection
enum<string>
default:desc

Sort direction (default desc)

Available options:
asc,
desc

Response

Paginated list of notes

​
items
object[]
​
totalCount
integer

Total number of notes for this entity