List Entity Types

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

{
  "entityTypes": [
    {
      "type": "Exposure",
      "displayName": "Exposure",
      "pluralDisplayName": "Exposures",
      "links": {
        "collection": "/api/v1/external/companies/550e8400-e29b-41d4-a716-446655440000/entities/exposure",
        "configuration": "/api/v1/external/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/external/companies/550e8400-e29b-41d4-a716-446655440000/entities/person",
        "configuration": "/api/v1/external/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

external

companies

{companyId}

entity-types

List Entity Types

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

{
  "entityTypes": [
    {
      "type": "Exposure",
      "displayName": "Exposure",
      "pluralDisplayName": "Exposures",
      "links": {
        "collection": "/api/v1/external/companies/550e8400-e29b-41d4-a716-446655440000/entities/exposure",
        "configuration": "/api/v1/external/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/external/companies/550e8400-e29b-41d4-a716-446655440000/entities/person",
        "configuration": "/api/v1/external/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

Overview Get Entity Configuration

⌘I