Skip to main content
The Exposures API allows you to manage exposure entities for your company. Exposures represent the individuals or organizations that are covered by insurance policies. Key Concepts:
  • Exposures are entities (individuals or organizations) covered by insurance policies
  • Each exposure has a name and entityType that classify them
  • Exposures can be associated with policies and events
  • Deleting an exposure performs a soft delete (the record is marked as deleted but retained)

​
API Endpoints

​
Exposure Fields

FieldTypeRequiredDescription
iduuid-Exposure identifier (returned in responses)
namestringYesName of the exposure
entityTypestringYesEntity type (e.g., “individual”, “organization”, “dealership”)
emailstringNoExposure email address
phoneNumberstringNoExposure phone number
billingEmailstringNoBilling email address
defaultBrokerIduuidNoDefault broker ID for this exposure
policyIdsuuid[]-IDs of associated policies (returned in list responses)
createdAtdatetime-When the exposure was created

​
Filtering and Sorting (List)

​
Filter Parameters

ParameterTypeDescription
iduuid or uuid[]Filter by exposure ID (single or array)
entityTypestringFilter by entity type
filterTextstringText search across exposure name

​
Sorting Parameters

ParameterTypeDefaultDescription
sortBystringcreatedAtField to sort by (createdAt, name, entityType)
sortDirectionstringdescSort direction (asc or desc)

​
Permissions

Access to exposures requires the appropriate permissions based on your API key:
OperationRequired Permission
List Exposurescompany.insured:read
Get Exposurecompany.insured:read
Create Exposurecompany.insured:create
Update Exposureinsured:update
Delete Exposureinsured:delete

​
Example List Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440200",
      "name": "John Smith",
      "entityType": "individual",
      "policyIds": ["550e8400-e29b-41d4-a716-446655440100"],
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "totalCount": 1
}

​
Example Create Request

{
  "name": "Acme Manufacturing GmbH",
  "entityType": "organization"
}

​
Example Create Response

{
  "id": "550e8400-e29b-41d4-a716-446655440003"
}

​
Example Update Request

{
  "name": "John Smith Jr.",
  "email": "[email protected]"
}

​
Example Update Response

{
  "id": "550e8400-e29b-41d4-a716-446655440200",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "John Smith Jr.",
  "entityType": "individual",
  "phoneNumber": null,
  "email": "[email protected]",
  "billingEmail": null,
  "defaultBrokerId": null,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "createdBy": "google-oauth2|123456789",
  "updatedAt": "2025-01-20T14:00:00.000Z",
  "updatedBy": "google-oauth2|987654321"
}

​
Example Delete Response

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "deleted": true
}