List Events

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

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "type": "claim",
      "status": "open",
      "referenceId": "CLM-2025-001",
      "coverageTypeId": "general_liability",
      "policyId": "550e8400-e29b-41d4-a716-446655440100",
      "insuredIds": [
        "550e8400-e29b-41d4-a716-446655440200",
        "550e8400-e29b-41d4-a716-446655440201"
      ],
      "createdAt": "2025-01-15T10:30:00.000Z",
      "createdBy": "google-oauth2|123456789",
      "updatedAt": "2025-01-16T14:20:00.000Z",
      "data": {
        "eventDescription": "Vehicle accident at intersection",
        "claimAmount": "50000",
        "dateOfLoss": "2025-01-10"
      }
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "type": "incident",
      "status": "closed",
      "referenceId": "INC-2025-002",
      "coverageTypeId": "property_damage",
      "policyId": "550e8400-e29b-41d4-a716-446655440101",
      "insuredIds": [
        "550e8400-e29b-41d4-a716-446655440202"
      ],
      "createdAt": "2025-01-10T08:00:00.000Z",
      "createdBy": "google-oauth2|987654321",
      "updatedAt": "2025-01-12T16:00:00.000Z",
      "data": null
    }
  ],
  "totalCount": 42
}

Events

List Events

Returns a paginated list of events (claims and incidents) for the company.

Events represent insurance claims and incidents. Each event includes:

Basic event information (type, status, reference ID)
Associated policy and insured references
Custom entity data specific to your company’s configuration

The data field contains custom entity data with field keys (not field IDs) mapped to values. Returns null when no custom data exists for the event.

Required permission: company.claim:read or company.incident:read (depending on event type filter)

GET

api

external

companies

{companyId}

events

List Events

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

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "type": "claim",
      "status": "open",
      "referenceId": "CLM-2025-001",
      "coverageTypeId": "general_liability",
      "policyId": "550e8400-e29b-41d4-a716-446655440100",
      "insuredIds": [
        "550e8400-e29b-41d4-a716-446655440200",
        "550e8400-e29b-41d4-a716-446655440201"
      ],
      "createdAt": "2025-01-15T10:30:00.000Z",
      "createdBy": "google-oauth2|123456789",
      "updatedAt": "2025-01-16T14:20:00.000Z",
      "data": {
        "eventDescription": "Vehicle accident at intersection",
        "claimAmount": "50000",
        "dateOfLoss": "2025-01-10"
      }
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "type": "incident",
      "status": "closed",
      "referenceId": "INC-2025-002",
      "coverageTypeId": "property_damage",
      "policyId": "550e8400-e29b-41d4-a716-446655440101",
      "insuredIds": [
        "550e8400-e29b-41d4-a716-446655440202"
      ],
      "createdAt": "2025-01-10T08:00:00.000Z",
      "createdBy": "google-oauth2|987654321",
      "updatedAt": "2025-01-12T16:00:00.000Z",
      "data": null
    }
  ],
  "totalCount": 42
}

Authorizations

Authorization

string

header

required

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

Path Parameters

companyId

string<uuid>

required

Company identifier

Query Parameters

type

Filter by event type (claim, incident, or both) Type of event (claim or incident)

Available options:

claim,

incident

status

Filter by event status (open, closed, or both) Status of the event

Available options:

open,

closed

policyId

string<uuid>

Filter by policy ID

filterText

string

Search across quote number, description, and other text fields

sortBy

enum<string>

default:createdAt

Field to sort by (default createdAt)

Available options:

createdAt,

updatedAt,

referenceId

sortDirection

enum<string>

default:desc

Sort direction (default desc)

Available options:

asc,

desc

page

integer

default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1

Response

Paginated list of events

items

object[]

Show child attributes

totalCount

integer

Total number of matching events across all pages

Overview Create Event

⌘I