Skip to main content
GET
Download Entity Export Run

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.

Query Parameters

format
enum<string>
default:csv

The file format to download: csv (the default) for the export's CSV, xlsx for its Excel workbook rendition. Any other value is a 400 — never silently defaulted, because that would serve a different file than the one asked for.

Available options:
csv,
xlsx

Response

The exported file, streamed as an attachment named {entityType}-export-{runId}.{format}.

The response is of type string.