Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
events
/
configuration
Get Events Configuration
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/events/configuration \
  --header 'Authorization: <api-key>'
{
  "data": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "eventDescription": {
        "type": "string",
        "title": "Event Description"
      },
      "claimAmount": {
        "type": "number",
        "title": "Claim Amount",
        "format": "currency"
      },
      "dateOfLoss": {
        "type": "string",
        "title": "Date of Loss",
        "format": "date"
      },
      "adjusterId": {
        "type": "string",
        "title": "Adjuster ID"
      },
      "claimCategory": {
        "type": "string",
        "title": "Claim Category",
        "enum": [
          "property",
          "liability",
          "auto",
          "workers_comp"
        ]
      }
    }
  },
  "fieldCoverageTypeMappings": {
    "eventDescription": "all",
    "claimAmount": "all",
    "dateOfLoss": "all",
    "adjusterId": [
      "general_liability",
      "workers_comp"
    ],
    "claimCategory": [
      "general_liability"
    ]
  },
  "companyCoverageTypes": [
    "general_liability",
    "workers_comp",
    "auto"
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your key in the Authorization header: Authorization: ApiKey YOUR-API-KEY

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Response

Configuration for event custom fields

Configuration response for events. Returns a JSON Schema for the data object used when creating or updating events, along with coverage type mappings that indicate which fields apply to which coverage types.

​
data
object
required

JSON Schema for the event data object. Includes all possible fields across all coverage types.

​
fieldCoverageTypeMappings
object
required

Maps field keys to their coverage type associations. Each key matches a property in data. Values are either:

  • "all" — field applies to all events regardless of coverage type
  • string[] — array of coverage type IDs the field applies to
​
companyCoverageTypes
string[]
required

All coverage type IDs enabled for the company (global + company-specific). Use this to check if a field's coverage type list effectively covers all types.