Skip to main content
GET
List Basic Policies

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

page
integer
default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1
sortBy
enum<string>

Field to sort by (defaults to createdAt)

Available options:
createdAt,
updatedAt,
number
sortDirection
enum<string>

Sort direction (defaults to desc)

Available options:
asc,
desc
id

Filter by one or more policy IDs

policyNumberFilterText
string

Case-insensitive substring match against policyNumber only. No other fields are searched. Prefer filters for matches against other fields.

filters
object[]

Structured per-field filters against FMV1 field data or system columns. See the FieldModelV1ListFilter schema for available filter shapes, field types, and operators. Multiple filters are combined with AND semantics.

Structured per-field filter against FMV1 field data or system columns. Each filter names a fieldReferenceId, a fieldType tag, an operator, and a value (plus valueTo for between and systemColumn for systemUser / systemDate). The set of operators and the value shape depend on fieldType. Pass one or more filters in the filters query parameter — multiple filters are combined with AND semantics.

Response

Paginated list of basic policies

items
object[]
required
totalCount
integer
required

Total number of matching policies