Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/types / Query

Type Alias: Query ​

Query: object

Type declaration ​

aggregate? ​

optional aggregate: Aggregate | null

alias? ​

optional alias: Record<string, string> | null

deep? ​

optional deep: NestedDeepQuery | null

export? ​

optional export: "json" | "csv" | "xml" | null

fields? ​

optional fields: string[] | null

filter? ​

optional filter: Filter | null

group? ​

optional group: string[] | null

limit? ​

optional limit: number | null

offset? ​

optional offset: number | null

page? ​

optional page: number | null

optional search: string | null

sort? ​

optional sort: string[] | null

version? ​

optional version: string | null

versionRaw? ​

optional versionRaw: boolean | null

Defined in ​

query.ts:3