Interface WidgetsApiSearchWidgetsRequest

Hierarchy

  • WidgetsApiSearchWidgetsRequest

Properties

experienceType filterCreatorHandle? filterIsFavorited? filterTags? filterTitle? filterWidgetType? pageNumber? pageSize? sort?

Properties

experienceType

experienceType: WidgetExperienceType

The experience type for the widget.

Optional filterCreatorHandle

filterCreatorHandle?: string

Filter widgets by the email handle of the creator.

Optional filterIsFavorited

filterIsFavorited?: boolean

Filter to only widgets favorited by the current user.

Optional filterTags

filterTags?: string

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

Optional filterTitle

filterTitle?: string

Filter widgets by title (substring match).

Optional filterWidgetType

filterWidgetType?: WidgetType

Filter widgets by widget type.

Optional pageNumber

pageNumber?: number

Page number for pagination (0-indexed).

Optional pageSize

pageSize?: number

Number of widgets per page.

Optional sort

sort?: string

Sort field for the results. Prefix with - for descending order. Allowed values: title, created_at, modified_at.

Settings

Member Visibility

Theme

Generated using TypeDoc