Interface WidgetsApiSearchWidgetsRequest

Hierarchy

  • WidgetsApiSearchWidgetsRequest

Properties

experienceType: WidgetExperienceType

The experience type for the widget.

filterCreatorHandle?: string

Filter widgets by the email handle of the creator.

filterIsFavorited?: boolean

Filter to only widgets favorited by the current user.

filterTags?: string

Filter widgets by tags. Format as bracket-delimited CSV, e.g. [tag1,tag2].

filterTitle?: string

Filter widgets by title (substring match).

filterWidgetType?: WidgetType

Filter widgets by widget type.

pageNumber?: number

Page number for pagination (0-indexed).

pageSize?: number

Number of widgets per page.

sort?: string

Sort field for the results.

title, created_at, modified_at — both ascending and descending are supported. Use the bare field name for ascending (e.g. sort=title) or prefix with - for descending (e.g. sort=-modified_at).

is_favorited — returns favorites-first ordering (favorited widgets first, then the rest). Direction is fixed; the - prefix is ignored for this field.

Generated using TypeDoc