List Entity Types

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

import requests

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

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}/entity-types', 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}/entity-types",
  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}/entity-types"

	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}/entity-types")

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

{
  "entityTypes": [
    {
      "type": "Exposure",
      "displayName": "Exposure",
      "pluralDisplayName": "Exposures",
      "links": {
        "collection": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/exposure",
        "configuration": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/exposure/configuration"
      },
      "permissions": {
        "read": "company.insured:read",
        "create": "company.insured:create",
        "update": "insured:update",
        "delete": "insured:delete"
      }
    },
    {
      "type": "Person",
      "displayName": "Person",
      "pluralDisplayName": "People",
      "links": {
        "collection": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/person",
        "configuration": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/person/configuration"
      },
      "permissions": {
        "read": "company.fmv1_custom_object:read",
        "create": "company.fmv1_custom_object:create",
        "update": "company.fmv1_custom_object:update",
        "delete": "company.fmv1_custom_object:delete"
      }
    }
  ]
}

Entities

List Entity Types

Discovery endpoint — returns the fixed set of CRUD entity TYPES (Event, Exposure, Quote, Submission, Person, Organization), each with display names, links to its /entities/{entityType} collection and /entities/{entityType}/configuration schema, and the per-action permission keys a client needs.

Custom objects never appear here: they are embedded-only and surface solely as Object / Object List field definitions inside an entity’s /configuration response, never as a top-level CRUD entity. Policy is also absent — its writes go through the policy transaction endpoints, though it does expose a read-only /configuration schema.

The path segment is /entity-types (not /entities): this describes entity SCHEMA/metadata, while /entities/{entityType} lists entity INSTANCES of one type.

Required permission: company.configuration:export

GET

api

companies

{companyId}

entity-types

List Entity Types

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

import requests

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

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}/entity-types', 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}/entity-types",
  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}/entity-types"

	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}/entity-types")

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

{
  "entityTypes": [
    {
      "type": "Exposure",
      "displayName": "Exposure",
      "pluralDisplayName": "Exposures",
      "links": {
        "collection": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/exposure",
        "configuration": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/exposure/configuration"
      },
      "permissions": {
        "read": "company.insured:read",
        "create": "company.insured:create",
        "update": "insured:update",
        "delete": "insured:delete"
      }
    },
    {
      "type": "Person",
      "displayName": "Person",
      "pluralDisplayName": "People",
      "links": {
        "collection": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/person",
        "configuration": "/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/entities/person/configuration"
      },
      "permissions": {
        "read": "company.fmv1_custom_object:read",
        "create": "company.fmv1_custom_object:create",
        "update": "company.fmv1_custom_object:update",
        "delete": "company.fmv1_custom_object:delete"
      }
    }
  ]
}

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

Response

The fixed set of CRUD entity-type descriptors.

entityTypes

object[]

required

Show child attributes

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

List Entity Types

Authorizations

Path Parameters

Response