Interface ElementFulltextSearchBody

interface ElementFulltextSearchBody {
    archived?: boolean;
    categorize?: boolean;
    matched?: boolean;
    organization?: string;
    page?: number;
    per_page?: number;
    projection?: Record<string, string[]>;
    query: string;
    type?: string[];
}

Properties

archived?: boolean
categorize?: boolean

Opt-in: when omitted/false the response is the legacy flat shape.

matched?: boolean

Opt-in: also return the attributes whose value matched the search term (and aren't already projected) as matched-attributes, so the card can highlight where the term was found. Absent/false leaves the response unchanged.

organization?: string

Restrict the search (and its type tabs) to elements owned by this organization.

page?: number
per_page?: number
projection?: Record<string, string[]>

Per-type map of attribute keys to project onto result cards ({ [typeId]: string[] }). Each hit is projected using only its own type's list. Ignored unless categorize is true.

query: string
type?: string[]

Ordered list of preferred element type ids. Present types lead the tabs in this order; absent ones are ignored. Ignored unless categorize is true.