List Entities

Lists or searches records of one type: claims and incidents (event), insureds (exposure), submissions, quotes, people (claimants, attorneys, brokers, contacts) or organizations (law firms, brokerages, vendors). Use it to find a record’s id by its name or a claim’s reference number with filterText, then read the record with Get Entity (getEntity). For a whole book as a CSV or spreadsheet, use Start Entity Export Run (startEntityExportRun); for policies, use List Policies (listPoliciesTransactionModel).

Returns a paginated list of {entityType} entities. One parametric endpoint serves all six CRUD entity types.

Free-text search (filterText) matches the whole phrase as a substring of a search index, not of every field. A record is indexed by its display name, an Event’s reference ID, and the fields your configuration’s searchFields rows name for this type, which can include a custom-object sub-field by its dotted path (vehicles.vin). Any other field is not searched, and neither is a linked record’s name. So a word that appears only in an unlisted field, such as a law firm’s name inside a claim’s lawsuit details, finds nothing. Export Configuration (exportFmv1Configuration) shows the searchFields rows. When a search misses, search the related record instead (for example the law firm as an organization, or the claimant as a person) and follow its link, filter on a declared listFilters key with filters, or walk the pages and read each record’s fieldModelV1Data. See the parameter.

Field-value filtering (filters) accepts tenant filters only as { fieldType: "declared", key, operator, value }, where key names a listFilters definition for this entity’s list surface. Explicit fixed system-filter forms remain supported. Implicit field-derived forms fail with HTTP 400 and code implicit-filters-disabled.

Sorting is config-driven — sortBy accepts createdAt (default), updatedAt, a declared list column key, or any configured field referenceId. An unknown or unsortable sortBy is a 400 InvalidSortBy.

Pagination is zero-based (pageNumber=0 is the first page); pageSize defaults to 51. To enumerate a whole book, walk pageNumber upward until hasMore is false, pairing it with an explicit sortBy / sortDirection so the ordering is fixed across the walk. pageNumber must be a non-negative integer and pageSize a positive integer; anything else is a 400.

Unrecognised query parameters are rejected with 400 InvalidRequest, and the message lists the ones this endpoint accepts. Paging has exactly one spelling here — pageNumber — so ?page=, ?offset=, ?cursor= and friends are errors rather than silently ignored. They used to be ignored, which made a book larger than one page impossible to walk: the endpoint kept answering with the first page and hasMore: true.

Required permission: <resource>.view for the entity’s resource (event.view, exposure.view, quote.view, submission.view, person.view, organization.view), derived from the path’s {entityType}. See Permissions.