Skip to main content
GET
List Policies

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

pageNumber
integer
default:0

Zero-based page index (default 0).

Required range: x >= 0
pageSize
integer
default:50

Number of records per page (default 50).

Required range: x >= 1
detail
enum<string>
required

Detail level. summary returns lightweight results with matched segment date ranges. full includes complete field data for each scope-matched segment.

Available options:
summary,
full
segmentScope
string
default:"all"

JSON-encoded segment scope filter. Controls which segments within each resolved version participate in filtering. Optional — defaults to "all" when omitted. Values:

  • "all" — every segment
  • {"asOf":"YYYY-MM-DD"} — point-in-time
  • {"fromDate":"YYYY-MM-DD","toDate":"YYYY-MM-DD"} — date range
filters
string

JSON-encoded array of filters combined with AND semantics.

Tenant filters must use { fieldType: "declared", key, operator, value }, where key names a listFilters definition on the policy surface. The definition supplies the SQL expression, result type, and permitted operators.

Explicit fixed system-filter forms (systemUser, systemDate, and systemId) remain supported. Implicit field-derived forms such as text, number, optionSet, or join fail with HTTP 400 and code implicit-filters-disabled.

See the Configuration API for the tenant's listFilters definitions.

timeTravelBackToDate
string<date>

Resolve each policy to the version that was latest at this date. Useful for reconstructing the book of business as it was known at a prior point in time.

sortBy
enum<string>

Field to sort results by

Available options:
policyId,
createdAt,
versionCreatedAt
sortDirection
enum<string>
default:desc

Sort direction (default desc)

Available options:
asc,
desc

Response

Paginated list of policies

Paginated list of policy results.

Why this differs from the entity list shape. A non-policy entity list (GET /entities/{entityType}) returns flat items, each a single { id, fieldModelV1Data, … } record. A policy list item instead carries a summary object (and, with detail=full, a segments array) — it has no single top-level field-data blob. This is by design: a Policy is a segmented entity assembled from immutable transactions, so its field data lives per-segment rather than in one flat record. The summary gives the policy-level view (id, full-term info, matched segment date ranges) and segments carries the per-segment data object when requested.

items
object[]
required
totalCount
integer
required

Total number of matching results across all pages