List Notes

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

import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/notes"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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-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
}

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>'

import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/notes"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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://app.aiinsurance.io/api/external/companies/{companyId}/{entityType}/{entityId}/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-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[]

Show child attributes

totalCount

integer

Total number of notes for this entity

Overview Create Note

⌘I

Getting Started

Submissions

Quotes

Assignees

Notes

Events

Brokerages

Brokers

Payees

Transaction Categories

Event Financials

Policies

Exposures

Attorneys

Lawsuits

Defendants

Configuration Fields

Configuration Rating Fields

Configuration Rating Outputs

Configuration Rating Presets

Configuration Rating Form Logic

Configuration Presets

Exposure Types

Coverage Types

Smart Tags

Address

Reference

List Notes

Authorizations

Path Parameters

Query Parameters

Response