Skip to main content
GET
List Entities

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

entityType
enum<string>
required

Field Model V1 entity type (lowercase kebab-case URL slug). One of the six CRUD entity types: event, exposure, quote, submission, person, organization. policy is NOT valid here — Policy has no generic CRUD (its writes go through the policy transaction endpoints), though it does have a read-only /configuration schema.

Available options:
event,
exposure,
quote,
submission,
person,
organization

Query Parameters

filterText
string

Search across quote number, description, and other text fields

filters
string

JSON-encoded array of filters applied server-side with AND semantics.

Tenant filters must be { "fieldType": "declared", "key", "operator", "value" }, where key names a listFilters definition for this entity's list surface. The definition controls the expression, logical result type, and permitted operators.

Explicit fixed system-filter forms (systemUser, systemDate, and systemId) are also supported. Implicit field-derived forms such as text, number, optionSet, or join fail with HTTP 400 and code implicit-filters-disabled; use the corresponding declared definition key.

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

sortBy
string
default:createdAt

Field to sort by. Accepts createdAt, updatedAt, or any configured field referenceId for the entity type (sorting is config-driven). Default createdAt.

sortDirection
enum<string>
default:desc

Sort direction (default desc)

Available options:
asc,
desc
pageNumber
integer
default:0

Zero-based page index (default 0).

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

Number of records per page (default 51).

Required range: x >= 1

Response

Paginated list of entities

items
object[]
hasMore
boolean

Whether more pages exist after this one

totalCount
integer

Total number of matching records across all pages