Summary
Search IAP
Description
Search through IAP for results from various collections that match your search term, as well as for results that have tags that match your search term.
Route
POST /search/find
Roles
admin
apiwrite
Parameters
Details Example Schema
Name
Type
Required
Description
data
object
yes
Search data object
Copied to Clipboard
{
"data": {
"text": "test",
"limit": 20,
"skip": 5
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"data": {
"title": "data",
"type": "object",
"properties": {
"text": {
"type": "string",
"examples": [
"test"
]
},
"limit": {
"type": "integer",
"examples": [
20
]
},
"skip": {
"type": "integer",
"examples": [
5
]
}
}
}
},
"required": [
"data"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
results
object
Search results
Copied to Clipboard
{
"results": [
{
"label": "Forms",
"type": "forms",
"results": [
{
"_id": "912fd926-5391-48ff-b265-394d00640f4f",
"name": "Name of the result.",
"description": "Hi I describe the result",
"url": "/formbuilder/edit?formid=912fd926-5391-48ff-b265-394d00640f4f",
"tags": [
{
"_id": "5c8fa4a8d8e04500b1b2f28f",
"description": "Description for the tag is optional.",
"name": "testTag"
}
]
}
],
"count": -57003740
}
]
}
