List File Categories

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories', 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://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories",
  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://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories")

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

{
  "categories": [
    "Applications",
    "Endorsements",
    "Loss Runs"
  ]
}

Company Files

List File Categories

List the file category vocabulary — company-wide, or scoped to one entity type’s admin-configured list via the optional entityType parameter.

Category values are stored as free text on a placement, and writes are never validated against the configured lists: setting a category via Update File or Update File Placement accepts any non-blank string up to 255 characters. This endpoint is the vocabulary to draw from so the set stays consistent instead of fragmenting. Company admins manage the configured lists in Company Settings → File Categories.

With entityType — that entity type’s configured categories in their configured order, followed by the labels in use on its live placements that no configured category covers. entityTypeCategories flags every entry with configured; categories repeats the same names in the same order without the flags. Categories are configured per entity type, so a Policy list and an Event list are independent. An unconfigured in-use value comes from an import, an API write, or a category an admin has removed — it stays listed so it remains visible and filterable.

Without entityType — the distinct category values in use across every owner’s live file placements, under categories alone:

The set is company-wide, not scoped to any owner: a category set on a company-level file and one set on a quote’s file both appear here.
Only live placements contribute — a category that survives only on a soft-deleted placement (or a soft-deleted file) is excluded. A category that is still in use on any live placement remains.
Values are returned once each, sorted case-insensitively.
The configured lists are not consulted, so a configured category that no file uses yet does not appear.
A company with no categorized live placements returns an empty array.

Required permission: company.file:read

GET

api

companies

{companyId}

files

categories

List File Categories

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories', 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://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories",
  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://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/files/categories")

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

{
  "categories": [
    "Applications",
    "Endorsements",
    "Loss Runs"
  ]
}

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

Query Parameters

entityType

enum<string>

Scope the read to one owner entity type's configured list. The lowercase kebab-case owner slug — PascalCase (e.g. Quote) is rejected with a 400. Omit for the company-wide in-use listing.

Available options:

company,

event,

exposure,

quote,

policy,

submission,

person,

organization

Response

The file category vocabulary

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

List File Categories

Authorizations

Path Parameters

Query Parameters

Response