List Rating Revision Form Logic

Returns all form-logic rules from a rating engine revision’s config JSON (config.policyFormLogicConfigs). Rules are returned as a flat list with no pagination.

Filtering:

• ruleName - Filter by rule name (exact match, non-empty)
• id - Filter by rule ID (single UUID or array)

Sorting:

• ruleName (default), rank
• Default direction: ascending
• Ties are broken by id ascending (or descending when sortDirection=desc)

Required permission: company:read

GET /api/external/companies/{companyId}/configuration/rating/form-logic

List Rating Revision Form Logic

cURL

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

200

success

{
  "items": [
    {
      "id": "bc6a626e-7a96-49fd-b477-2b18cf189a0d",
      "ruleName": "Attach Certificate of Insurance",
      "rank": 1,
      "step": "policies",
      "shouldAdd": {
        "leftKey": "form.number",
        "operator": "=",
        "rightValue": "FM-0001"
      }
    },
    {
      "id": "7dc1e6fa-9f03-4b81-8f36-ee9fb5b5fde5",
      "ruleName": "Attach state-specific endorsement",
      "rank": 2,
      "step": [
        "policies",
        "quotes"
      ],
      "shouldAdd": {
        "operator": "AND",
        "conditions": [
          {
            "leftKey": "form.number",
            "operator": "=",
            "rightValue": "FM-0002"
          },
          {
            "leftKey": "policy.data.state",
            "operator": "=",
            "rightValue": "CA"
          }
        ]
      }
    }
  ]
}

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

ratingEngineRevisionId · string<uuid> · required

The rating engine revision ID (must exist and belong to the company)

ruleName · string

Filter to rules whose ruleName matches exactly. Must be non-empty when provided.

Minimum string length: 1

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

Filter to a single rule ID or an array of rule IDs

sortBy · enum<string> · default: ruleName

Field to sort by (default ruleName)

Available options: ruleName, rank

sortDirection · enum<string> · default: asc

Sort direction (default asc)

Available options: asc, desc

Response

200

application/json

List of form-logic rules

items · object[] · required

Show child attributes