List Notes

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/notes \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/notes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/notes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440020",
      "entityType": "event",
      "entityId": "550e8400-e29b-41d4-a716-446655440200",
      "note": "Adjuster called the insured for clarification.",
      "displayDate": null,
      "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
}

Notes

List Notes

Returns a paginated list of notes for a parent entity, newest first by the note’s display date (displayDate when set, else createdAt) — so backdated historical notes interleave correctly.

The parent entity is selected by the entityType (lowercase kebab-case) and entityId query parameters. Pagination is 1-based via page/pageSize. Pass search to filter to notes whose body contains a substring (case-insensitive).

Required permission: company.note:read.

GET

api

companies

{companyId}

notes

List Notes

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/notes \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/notes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/notes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440020",
      "entityType": "event",
      "entityId": "550e8400-e29b-41d4-a716-446655440200",
      "note": "Adjuster called the insured for clarification.",
      "displayDate": null,
      "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 (lowercase kebab-case URL slug), e.g. event, exposure, policy. Selects the per-entity permission enforced for the request and scopes the note to its parent entity. PascalCase (Event) is rejected with a 400 — matching the /entities/{type} path convention.

Available options:

event,

exposure,

quote,

submission,

person,

organization,

policy

entityId

string<uuid>

required

Parent entity identifier whose notes are being listed

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).

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[]

Show child attributes

totalCount

integer

Total number of matching notes across all pages

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

List Notes

Authorizations

Path Parameters

Query Parameters

Response