List Configuration Fields
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/fields \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/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/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/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/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/fields")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/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",
"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
}Configuration Fields
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 --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/fields \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/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/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/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/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/fields")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/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",
"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
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
Available options:
events, insureds, policies 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?