List Configuration Fields

Returns a paginated list of configuration fields for the company. Only returns entity fields (events, insureds, policies) — rating fields are managed through separate endpoints.

Filtering:

• id - Filter by field ID (single UUID or array)
• entityName - Filter by entity type (events, insureds, policies)

Sorting:

• createdAt (default), updatedAt

Required permission: company:read

GET /api/external/companies/{companyId}/configuration/fields

List Configuration Fields

cURL

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

200

success

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440100",
      "entityName": "policies",
      "fieldDefinition": {
        "className": "InputField",
        "key": "policyState",
        "path": "policyState",
        "label": "Policy State",
        "section": "Policy Information",
        "required": true
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-20T14:00:00.000Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440101",
      "entityName": "insureds",
      "fieldDefinition": {
        "className": "SelectField",
        "key": "dealerType",
        "path": "dealerType",
        "label": "Dealer Type",
        "section": "General",
        "fields": {
          "options": [
            {
              "label": "Franchise",
              "value": "franchise"
            },
            {
              "label": "Non-Franchise",
              "value": "nonfranchise"
            }
          ]
        }
      },
      "createdAt": "2025-01-10T08:00:00.000Z",
      "updatedAt": null
    }
  ],
  "totalCount": 2
}

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

id · string<uuid> string<uuid>[]

Filter by field ID (single UUID or array of UUIDs)

entityName · enum<string>

Filter by entity type

Available options: events, insureds, policies

sortBy · enum<string> · default: createdAt

Field to sort by (default createdAt)

Available options: createdAt, updatedAt

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

200

application/json

Paginated list of configuration fields

items · object[]

Show child attributes

totalCount · integer

Total number of matching fields across all pages