Get Entity Export Run

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}', 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}/entities/{entityType}/export-runs/{runId}",
  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: Bearer <token>"
  ],
]);

$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}/entities/{entityType}/export-runs/{runId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "runId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "queued",
  "rowCount": null,
  "error": null,
  "createdAt": "2026-08-18T12:00:00.000Z",
  "updatedAt": "2026-08-18T12:00:00.000Z",
  "finishedAt": null,
  "expiresAt": "2026-09-17T12:00:00.000Z"
}

Entities

Get Entity Export Run

Reports the status of an export run started by POST /entities/{entityType}/export-runs.

Poll this until status is terminal, then fetch the CSV from GET .../export-runs/{runId}/download if it succeeded.

Statuses

queued — the run exists and is waiting for a worker. A normal state every run passes through, not a stall: the run is recorded before the background work is dispatched.
running — the export is streaming rows into its CSV.
succeeded — the file is parked and downloadable. rowCount and finishedAt are set.
failed — the export stopped early. error carries the reason; start a new run to retry.
expired — the run succeeded, but its CSV has passed the retention horizon (expiresAt) and been deleted. The run’s facts (rowCount, timestamps) remain readable; start a new export for a fresh file.

The body is fixed-size — the export request is not echoed back — so a poll costs the same however large the export is.

A run’s status stays readable for as long as the run exists: nothing removes a run on a timer (only its FILE expires), and a run id belonging to another company — or reached through a different entity type’s path than the one it was started under — is a 404, exactly as an id that exists nowhere.

Required permission: company.{entity}:list — the exact key varies by type (Policy uses company.policy:export), derived from the path’s {entityType}. See Permissions.

GET

api

companies

{companyId}

entities

{entityType}

export-runs

{runId}

Get Entity Export Run

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}', 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}/entities/{entityType}/export-runs/{runId}",
  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: Bearer <token>"
  ],
]);

$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}/entities/{entityType}/export-runs/{runId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/export-runs/{runId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "runId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "queued",
  "rowCount": null,
  "error": null,
  "createdAt": "2026-08-18T12:00:00.000Z",
  "updatedAt": "2026-08-18T12:00:00.000Z",
  "finishedAt": null,
  "expiresAt": "2026-09-17T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId

string<uuid>

required

Company identifier

entityType

enum<string>

required

Field Model V1 EXPORTABLE entity type (lowercase kebab-case URL slug): the six CRUD entity types plus policy. Unlike the CRUD entity routes, policy IS valid here — a Policy export reads the segment in effect on the asOf date (defaulting to today).

Available options:

event,

exposure,

quote,

submission,

person,

organization,

policy

runId

string<uuid>

required

The run identifier returned by POST /entities/{entityType}/export-runs. Runs are scoped to their company AND their entity type: a run id belonging to another company, or started under a different entity type, returns 404, exactly as an id that exists nowhere does.

Response

The run's current status

An export run's current status. Fixed size: there is no echo of the export request, so a poll costs the same however large the export is.

runId

string<uuid>

required

The run identifier

status

enum<string>

required

queued while the run waits for a worker (a normal state, not a stall), running while it projects and streams, then the terminal succeeded or failed — and expired once a succeeded run's CSV has passed its retention horizon and been deleted

Available options:

queued,

running,

succeeded,

failed,

expired

rowCount

integer | null

required

Data rows written to the CSV (the header row not counted); null until the run succeeds. It stays populated on an expired run, describing the file that existed.

error

string | null

required

Why the export stopped; null unless status is failed

createdAt

string<date-time>

required

When the run was started

updatedAt

string<date-time>

required

When the run last made progress or changed status

finishedAt

string<date-time> | null

required

When the run reached a terminal status; null until then

expiresAt

string<date-time>

required

When the run's CSV artifact passes its retention horizon. After this instant the run reports expired and the download answers 404 — start a new export for a fresh file.

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Get Entity Export Run

Statuses

Authorizations

Path Parameters

Response