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"
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use format: 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.

​
data
object
required

JSON Schema for the event data object