Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
notes
List Notes
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/notes \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440020",
      "entityType": "Event",
      "entityId": "550e8400-e29b-41d4-a716-446655440200",
      "note": "Adjuster called the insured for clarification.",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "createdBy": "550e8400-e29b-41d4-a716-446655440999",
      "createdByName": "Jane Adjuster",
      "updatedAt": "2026-01-15T10:30:00.000Z",
      "updatedBy": "550e8400-e29b-41d4-a716-446655440999"
    }
  ],
  "totalCount": 1
}

Authorizations

​
Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Query Parameters

​
entityType
enum<string>
required

Parent entity type (PascalCase). Selects the per-entity permission enforced for the request and scopes the note to its parent entity.

Available options:
Event,
Exposure,
Quote,
Submission,
Person,
Organization,
Policy
​
entityId
string<uuid>
required

Parent entity identifier whose notes are being listed

​
search
string

Optional case-insensitive substring filter. When provided, only notes whose body contains this text are returned (matches anywhere in the note).

​
page
integer
default:1

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

Required range: x >= 1
​
pageSize
integer
default:50

Number of records per page (default 50).

Required range: x >= 1

Response

Paginated list of notes

​
items
object[]
​
totalCount
integer

Total number of matching notes across all pages