Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
insureds
List Insureds
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/insureds \
  --header 'Authorization: <api-key>'
{
  "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"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440201",
      "name": "Acme Corporation",
      "entityType": "organization",
      "policyIds": [
        "550e8400-e29b-41d4-a716-446655440100",
        "550e8400-e29b-41d4-a716-446655440101"
      ],
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ],
  "totalCount": 42
}

Authorizations

​
Authorization
string
header
required

Use format: ApiKey <your-api-key>

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Query Parameters

​
id

Filter by insured ID (single or array)

​
entityType
string

Filter by entity type

​
filterText
string

Search across quote number, description, and other text fields

​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
name,
entityType
​
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 insureds

​
items
object[]
​
totalCount
integer

Total number of matching insureds across all pages