List Configuration Rating Fields

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

Filtering:

• id - Filter by field ID (single UUID or array)
• entityType - Filter by entity type (e.g., “policies”, “dealership”)

Sorting:

• createdAt (default), updatedAt

Required permission: company:read

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

List Configuration Rating Fields

cURL

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

200

success

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440100",
      "entityType": "franchise_truck_dealer",
      "rank": 5,
      "fieldDefinition": {
        "className": "SelectField",
        "key": "earthquakeZone1",
        "path": "data.earthquakeZone1",
        "label": "Earthquake Zone",
        "required": true,
        "fields": {
          "type": "text",
          "options": [
            {
              "label": "Yes",
              "value": "0"
            },
            {
              "label": "No",
              "value": "10"
            }
          ]
        }
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-20T14:00:00.000Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440101",
      "entityType": "franchise_truck_dealer",
      "rank": null,
      "fieldDefinition": {
        "className": "StaticField",
        "key": "county1",
        "path": "data.insuredLocation1.structuredValue.county",
        "label": "County",
        "section": "Location",
        "value": {
          "path": "data.insuredLocation1.structuredValue.county",
          "requiredFields": [
            "d07f408c-a00e-4a4a-bdad-aa1d45f6baf6"
          ]
        }
      },
      "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)

entityType · string

Filter by entity type (e.g., "policies", "dealership", "company")

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 rating fields

items · object[]

Show child attributes

totalCount · integer

Total number of matching fields across all pages