EntityQueryRecordsOptions

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

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

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

Type Declaration

expansionLevel?

optional expansionLevel: number

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

filterGroup?

optional filterGroup: EntityQueryFilterGroup

Filter conditions to apply

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