Compare Configuration

curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
  "googleOAuthToken": "ya29.a0AfH6SM..."
}
'

{
  "fieldDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 42
  },
  "optionSets": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 8
  },
  "customObjects": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 3
  },
  "cardDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 12
  },
  "cardPageRelationships": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 6
  },
  "fieldLocations": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 38
  }
}

Configuration Management

Compare Configuration

Compares an FMV1 configuration spreadsheet against the current database state and returns a diff summary. Each configuration category (field definitions, option sets, custom objects, etc.) includes counts of additions, updates, deletes, and unchanged items.

Use this to preview what an import would change before applying it.

The caller must provide their own Google OAuth2 access token with read permission on the target spreadsheet.

Required permission: company.configuration:export

This endpoint requires an API key created with the FMV1_CONFIGURATION_MANAGER role. See Authentication for how to create API keys with specific roles.

POST

/

api

/

v1

/

external

/

companies

/

{companyId}

/

configuration

/

compare

Compare Configuration

curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
  "googleOAuthToken": "ya29.a0AfH6SM..."
}
'

{
  "fieldDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 42
  },
  "optionSets": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 8
  },
  "customObjects": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 3
  },
  "cardDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 12
  },
  "cardPageRelationships": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 6
  },
  "fieldLocations": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 38
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId

string<uuid>

required

Company identifier

Body

application/json

Request body for FMV1 configuration spreadsheet operations

spreadsheetId

string

required

The ID of the target Google Spreadsheet

googleOAuthToken

string

required

A valid Google OAuth2 access token with Google Sheets access permission

Response

Comparison completed

Diff between a spreadsheet and the current database configuration

fieldDefinitions

object

required

Change counts for a single configuration category

Show child attributes

optionSets

object

required

Change counts for a single configuration category

Show child attributes

customObjects

object

required

Change counts for a single configuration category

Show child attributes

cardDefinitions

object

required

Change counts for a single configuration category

Show child attributes

cardPageRelationships

object

required

Change counts for a single configuration category

Show child attributes

fieldLocations

object

required

Change counts for a single configuration category

Show child attributes

Validate Configuration Spreadsheet Import Configuration

⌘I