Get Coverage Type Fields

Returns the list of field keys associated with a given coverage type.

Fields are sourced from both the database (entity_type_fields table) and static configuration, then merged and deduplicated. The returned field keys are human-readable strings (e.g., “reportDate”) that match the keys used in event data objects.

Required permission: company.event:export

GET /api/external/companies/{companyId}/coverage-types/{coverageTypeId}/fields

Get Coverage Type Fields

cURL

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

200

withFields

{
  "coverageTypeId": "general_liability",
  "coverageTypeName": "General Liability",
  "fields": [
    "reportDate",
    "eventDescription",
    "settlementDemand",
    "indemnityPaid",
    "alaeReserveAmount"
  ],
  "metadata": {
    "coverageTypeScope": "global",
    "fieldSources": [
      "database",
      "static"
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

companyId · string<uuid> · required

Company identifier

coverageTypeId · string · required

Coverage type identifier (e.g., "general_liability")

Response

200

application/json

Fields for the specified coverage type

Fields associated with a coverage type

coverageTypeId · string · required

The coverage type identifier

coverageTypeName · string · required

Human-readable name of the coverage type

fields · string[] · required

Field keys associated with this coverage type

metadata · object · required

Additional information about the coverage type and field sources

Show child attributes