List Entities

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

import requests

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

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

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

print(response.text)

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

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}', 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}/entities/{entityType}",
  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}/entities/{entityType}"

	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}/entities/{entityType}")

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-446655440301",
      "fieldModelV1Data": {
        "exposureName": "Acme Corp HQ"
      },
      "createdAt": 1736937000,
      "createdBy": "google-oauth2|123456789",
      "updatedAt": 1736937000,
      "updatedBy": null,
      "createdByName": "Jane Adjuster",
      "updatedByName": null
    }
  ],
  "hasMore": false,
  "totalCount": 1
}

Entities

List Entities

Returns a paginated list of {entityType} entities. One parametric endpoint serves all six CRUD entity types.

Free-text search (filterText) matches the entity’s configured display field (e.g. exposureName, submissionNumber/submissionName).

Field-value filtering (filters) narrows the list server-side by any configured field value — use it to look an entity up by a business key instead of paging the whole collection. It accepts the same JSON-encoded filter array as the List Policies endpoint.

Sorting is config-driven — sortBy accepts createdAt (default), updatedAt, or any configured field referenceId.

Pagination is zero-based (pageNumber=0 is the first page); pageSize defaults to 51.

Required permission: company.{entity}:read — the exact key varies by type. See Permissions.

GET

api

companies

{companyId}

entities

{entityType}

List Entities

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

import requests

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

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

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

print(response.text)

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

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}', 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}/entities/{entityType}",
  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}/entities/{entityType}"

	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}/entities/{entityType}")

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-446655440301",
      "fieldModelV1Data": {
        "exposureName": "Acme Corp HQ"
      },
      "createdAt": 1736937000,
      "createdBy": "google-oauth2|123456789",
      "updatedAt": 1736937000,
      "updatedBy": null,
      "createdByName": "Jane Adjuster",
      "updatedByName": null
    }
  ],
  "hasMore": false,
  "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

entityType

enum<string>

required

Field Model V1 entity type (lowercase kebab-case URL slug). One of the six CRUD entity types: event, exposure, quote, submission, person, organization. policy is NOT valid here — Policy has no generic CRUD (its writes go through the policy transaction endpoints), though it does have a read-only /configuration schema.

Available options:

event,

exposure,

quote,

submission,

person,

organization

Query Parameters

filterText

string

Search across quote number, description, and other text fields

filters

string

JSON-encoded array of field filters applied server-side against the entity's fieldModelV1Data. Use this to look an entity up by a business key (e.g. a document ID or any configured field value) instead of paging the whole collection and matching client-side. Complements filterText, which only searches the configured display field.

Each filter is { fieldReferenceId, fieldType, operator, value } and supports type-specific operators. Supported field types: text, number, boolean, date, currency, optionSet, address, join, textList, numberList, optionSetList, addressList. This is the same filter shape the List Policies endpoint accepts.

List-cardinality types support operators: listIncludes (textList, numberList, addressList), listIn, listAll, listExcludes (optionSetList). The join type supports the in operator.

See the Configuration API for available field reference IDs.

sortBy

string

default:createdAt

Field to sort by. Accepts createdAt, updatedAt, or any configured field referenceId for the entity type (sorting is config-driven). Default createdAt.

sortDirection

enum<string>

default:desc

Sort direction (default desc)

Available options:

asc,

desc

pageNumber

integer

default:0

Zero-based page index (default 0).

Required range: x >= 0

pageSize

integer

default:51

Number of records per page (default 51).

Required range: x >= 1

Response

Paginated list of entities

items

object[]

Show child attributes

hasMore

boolean

Whether more pages exist after this one

totalCount

integer

Total number of matching records 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 Entities

Authorizations

Path Parameters

Query Parameters

Response