Skip to main content
GET
Get Basic Policy

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId
string<uuid>
required

Company identifier

policyId
string<uuid>
required

Policy identifier

Response

Basic policy detail

A basic policy — flat fieldModelV1Data object with company-configured fields plus a nested exposures array. Returned by GET /policies (list items) and GET /policies/{policyId} (single).

id
string<uuid>
required

Policy identifier.

companyId
string<uuid>
required

Company identifier.

fieldModelV1Data
object
required

Flat policy object. Keys are field referenceIds from the company's FMV1 configuration. The exposures key is a nested array of exposure objects, each of which has an id referencing an existing exposure record plus any company-configured exposure fields. Date-typed fields appear in canonical { day, month, year, timezone } form.

createdAt
string<date-time>
required

ISO-8601 timestamp of policy creation.

updatedAt
string<date-time> | null
required

ISO-8601 timestamp of last update, or null if never updated.

createdBy
string | null
required

User or API key that created the policy.

updatedBy
string | null
required

User or API key of the most recent update, or null if never updated.