List Configuration Rating Fields
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}Configuration Rating Fields
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 --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Query Parameters
Filter by field ID (single UUID or array of UUIDs)
Filter by entity type (e.g., "policies", "dealership", "company")
Field to sort by (default createdAt)
Available options:
createdAt, updatedAt Sort direction (default desc)
Available options:
asc, desc Page number (1-based, default 1, page size 50)
Required range:
x >= 1Was this page helpful?