EntityQueryRecordsOptions

EntityQueryRecordsOptions = { aggregates?: EntityAggregate[]; expansionLevel?: number; filterGroup?: EntityQueryFilterGroup; groupBy?: string[]; selectedFields?: string[]; sortOptions?: EntityQuerySortOption[]; } & PaginationOptions

Options for querying entity records with filters, sorting, aggregates, and pagination.

Use pageSize, cursor, or jumpToPage for SDK-managed pagination. The SDK computes and manages offset parameters automatically.

Type Declaration¶

aggregates?¶

optional aggregates: EntityAggregate[]

Aggregate expressions (COUNT, SUM, AVG, MIN, MAX) to apply across the result set.

expansionLevel?¶

optional expansionLevel: number

Level of entity expansion for related fields (default: 0)

optional filterGroup: EntityQueryFilterGroup

Filter conditions to apply

groupBy?¶

optional groupBy: string[]

Field names to group aggregate results by.

selectedFields?¶

optional selectedFields: string[]

List of field names to include in results (returns all fields if omitted)

sortOptions?¶

optional sortOptions: EntityQuerySortOption[]

Sort options for the results