Get Custom Object Configuration
curl --request GET \
--url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration"
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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration', 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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration",
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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration"
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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration")
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{
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"vehicleMake": {
"type": "string",
"title": "vehicleMake"
},
"vehicleModel": {
"type": "string",
"title": "vehicleModel"
},
"year": {
"type": "number",
"title": "year"
},
"vin": {
"type": "string",
"title": "vin"
}
},
"required": [
"vehicleMake",
"vehicleModel"
]
},
"relationships": [
{
"fieldRefId": "ownerExposure",
"label": "Owner Exposure",
"targetType": "exposure",
"cardinality": "many_to_one"
}
]
}Custom Objects
Get Custom Object Configuration
Returns the field configuration for a custom object type. The response includes:
data: A JSON Schema describing the regular fields available for create and update operations.relationships: An array of relationship field metadata, each containing thefieldRefIdto use with the relationship management endpoints.
Required permission: company.fmv1_custom_object:read
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
custom-objects
/
{objectType}
/
configuration
Get Custom Object Configuration
curl --request GET \
--url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration"
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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration', 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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration",
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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration"
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/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/custom-objects/{objectType}/configuration")
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{
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"vehicleMake": {
"type": "string",
"title": "vehicleMake"
},
"vehicleModel": {
"type": "string",
"title": "vehicleModel"
},
"year": {
"type": "number",
"title": "year"
},
"vin": {
"type": "string",
"title": "vin"
}
},
"required": [
"vehicleMake",
"vehicleModel"
]
},
"relationships": [
{
"fieldRefId": "ownerExposure",
"label": "Owner Exposure",
"targetType": "exposure",
"cardinality": "many_to_one"
}
]
}Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Custom object type in snake_case format (e.g., vehicle, building_info)
Response
Configuration for custom object type
Configuration response for a custom object type. Returns the JSON Schema for data fields and metadata about relationship fields.
Standard JSON Schema (draft 2020-12) describing field definitions
for Field Model V1 entities. Includes a required array listing
fields that must be provided.
Show child attributes
Show child attributes
Relationship fields available on this custom object type. Each entry
provides the fieldRefId to use when adding or removing relationships
via the relationship management endpoints.
Show child attributes
Show child attributes
Was this page helpful?