Skip to main content
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>'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.aiinsurance.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

​
objectType
string
required

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.

​
data
object
required

Standard JSON Schema (draft 2020-12) describing field definitions for Field Model V1 entities. Includes a required array listing fields that must be provided.

​
relationships
object[]
required

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.