Get Event

Returns a single event by ID.

Use expand=insureds to include full insured details instead of just IDs.

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

GET /api/external/companies/{companyId}/events/{eventId}

Get Event

cURL

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

200

withInsuredIds

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

Authorizations

Authorization · string · header · required

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

Path Parameters

companyId · string<uuid> · required

Company identifier

eventId · string<uuid> · required

Event identifier

Query Parameters

expand · enum<string>

Expand related entities. Use insureds to include full insured details instead of IDs.

Available options: insureds

Response

200

application/json

Event details

Option 1

Option 2

An event (claim or incident) in the system

id · string<uuid>

Event identifier

companyId · string<uuid>

Company identifier

type · enum<string>

Type of event (claim or incident)

Available options: claim, incident

status · enum<string>

Status of the event

Available options: open, closed

referenceId · string

Human-readable reference ID for the event

Example:

"CLM-2025-001"

coverageTypeId · string

Coverage type identifier for this event

Example:

"general_liability"

lawsuitId · string<uuid> | null

Associated lawsuit ID (null if no lawsuit exists for this event)

policyId · string<uuid> | null

Associated policy ID (null if not linked to a policy)

insuredIds · string<uuid>[]

IDs of insureds associated with this event

createdAt · string<date-time>

When the event was created (ISO 8601)

createdBy · string | null

User ID who created the event (null if not tracked)

updatedAt · string<date-time> | null

When the event was last updated (ISO 8601), or null if never updated

data · object | null

Custom entity data with field keys mapped to values. Returns null when no custom data exists.

Show child attributes

Example:

{
  "eventDescription": "Vehicle accident at intersection",
  "claimAmount": "50000",
  "dateOfLoss": "2025-01-10"
}