Search for an object

This query returns the best-matching object in your Capacities space for a keyword you supply, matched against object titles.

Developer info

API endpoint slug: capacities.search_for_an_object
Runtime method: performQuery("capacities.search_for_an_object"}

Query fields

Keyword Text input > Other

Label: Keyword
Helper text: The word or phrase to look for. Capacities matches it against object titles, not note contents.
Slug: keyword
Required: true
Can have default value: true

Object type Dropdown list

Label: Object type
Helper text: Choose the kind of object to search, or Any type to search all of them.
Slug: object_type
Required: true
Can have default value: false

Ingredients

Object title The title of the best-matching object, taken directly from results[0].title.

Slug: object_title
Filter: Capacities.searchForAnObject.ObjectTitle
Type: String
Example: Weekly review

Object type The matched object's type, taken directly from results[0].structureId: a built-in structure id such as RootPage, or a UUID for a custom type.

Slug: object_type_id
Filter: Capacities.searchForAnObject.ObjectTypeId
Type: String
Example: RootPage

Object The matched object's ID, taken directly from results[0].id.

Slug: object_id
Filter: Capacities.searchForAnObject.ObjectId
Type: String
Example: 00000000-0000-4000-8000-000000000000

Applets using this Query