Get Event Configuration

Returns a JSON Schema describing the fields available for creating or updating Field Model V1 events.

The fields schema is a standard JSON Schema (draft 2020-12) that can be used directly with validation libraries like Ajv or Zod. The required array lists fields that must be provided when creating or updating an event.

Required permission: company.event:export

GET /api/v1/external/companies/{companyId}/events/configuration

Get Event Configuration

cURL

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

200

withCustomFields

{
  "fields": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "eventType": {
        "type": "string",
        "title": "eventType"
      },
      "eventCoverageType": {
        "type": "string",
        "title": "eventCoverageType"
      },
      "eventInsureds": {
        "type": "object",
        "title": "eventInsureds"
      },
      "lossDescription": {
        "type": "string",
        "title": "lossDescription"
      },
      "lossDate": {
        "type": "string",
        "title": "lossDate"
      }
    },
    "required": [
      "eventType",
      "eventCoverageType",
      "eventInsureds"
    ]
  }
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId · string<uuid> · required

Company identifier

Response

200

application/json

Configuration for event fields

Configuration response for Field Model V1 events. Returns a JSON Schema describing the fields available for creating or updating events.

fields · object · required

JSON Schema (draft 2020-12) describing the valid fields for the event request body. Each property corresponds to a field referenceId in the company's configuration.

Show child attributes