Document Search Form API

The Document Search Form API enables you to easily embed the search form for the app on any other page.

Learn more about APIs.

Minimum Tag

{{ _api.document.searchForm.template('template-key') }}

Example Tags

Get the search form for a specific Document app instance.

This is only necessary if there are multiple app instances.

{{ _api.document.searchForm.template('template-key').instanceKey('app-instance-key') }}

Tag Parameters

ParameterDescription
instanceKey The key for the instance to get results in. If nothing is passed then the current instance will be used if this is called within the same app.

Type: String

Example:
instanceKey('appInstanceKey')
template Required if responseFormat is not 'data'. The template key of the template to use.

If this is not passed when it's required then nothing will be returned. In some cases by not passing this parameter you will get just the raw data back.

Type: String

Example:
template('template-key')