Get Coverage Type Fields
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types/{coverageTypeId}/fields \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/fields")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types/{coverageTypeId}/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{
"coverageTypeId": "general_liability",
"coverageTypeName": "General Liability",
"fields": [
"reportDate",
"eventDescription",
"settlementDemand",
"indemnityPaid",
"alaeReserveAmount"
],
"metadata": {
"coverageTypeScope": "global",
"fieldSources": [
"database",
"static"
]
}
}
Coverage Types
Get Coverage Type Fields
Returns the list of field keys associated with a given coverage type.
Fields are sourced from both the database (entity_type_fields table)
and static configuration, then merged and deduplicated. The returned
field keys are human-readable strings (e.g., “reportDate”) that match
the keys used in event data objects.
Required permission: company.event:export
GET
/
api
/
external
/
companies
/
{companyId}
/
coverage-types
/
{coverageTypeId}
/
fields
Get Coverage Type Fields
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types/{coverageTypeId}/fields \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/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}/coverage-types/{coverageTypeId}/fields")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/coverage-types/{coverageTypeId}/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{
"coverageTypeId": "general_liability",
"coverageTypeName": "General Liability",
"fields": [
"reportDate",
"eventDescription",
"settlementDemand",
"indemnityPaid",
"alaeReserveAmount"
],
"metadata": {
"coverageTypeScope": "global",
"fieldSources": [
"database",
"static"
]
}
}
Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Coverage type identifier (e.g., "general_liability")
Response
Fields for the specified coverage type
Fields associated with a coverage type
The coverage type identifier
Human-readable name of the coverage type
Field keys associated with this coverage type
Additional information about the coverage type and field sources
Show child attributes
Show child attributes
Was this page helpful?