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..."
}
'

import requests

url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare"

payload = {
    "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
    "googleOAuthToken": "ya29.a0AfH6SM..."
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    spreadsheetId: '1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms',
    googleOAuthToken: 'ya29.a0AfH6SM...'
  })
};

fetch('https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare', 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}/configuration/compare",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'spreadsheetId' => '1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms',
    'googleOAuthToken' => 'ya29.a0AfH6SM...'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare"

	payload := strings.NewReader("{\n  \"spreadsheetId\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n  \"googleOAuthToken\": \"ya29.a0AfH6SM...\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spreadsheetId\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n  \"googleOAuthToken\": \"ya29.a0AfH6SM...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spreadsheetId\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n  \"googleOAuthToken\": \"ya29.a0AfH6SM...\"\n}"

response = http.request(request)
puts response.read_body

{
  "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
  },
  "cardSections": {
    "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

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..."
}
'

import requests

url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare"

payload = {
    "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
    "googleOAuthToken": "ya29.a0AfH6SM..."
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    spreadsheetId: '1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms',
    googleOAuthToken: 'ya29.a0AfH6SM...'
  })
};

fetch('https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare', 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}/configuration/compare",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'spreadsheetId' => '1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms',
    'googleOAuthToken' => 'ya29.a0AfH6SM...'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare"

	payload := strings.NewReader("{\n  \"spreadsheetId\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n  \"googleOAuthToken\": \"ya29.a0AfH6SM...\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spreadsheetId\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n  \"googleOAuthToken\": \"ya29.a0AfH6SM...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/configuration/compare")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spreadsheetId\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n  \"googleOAuthToken\": \"ya29.a0AfH6SM...\"\n}"

response = http.request(request)
puts response.read_body

{
  "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
  },
  "cardSections": {
    "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. Include your API key in the Authorization header.

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