Perform a free-text search on all documents in the current workspace.
get/silo/v1/search
Query parameters
qstring required
Search query string.
Example:TEST
Search query string.
folderstring
Folder to search within.
Example:invoices
Folder to search within.
limitinteger
Maximum number of entries to show in a page of results.
Example:20
Maximum number of entries to show in a page of results.
offsetinteger
The number of entries to skip in the result set.
Example:10
The number of entries to skip in the result set.
Response
OK
Example response
{
"folder": "sales",
"limit": 20,
"list": [
{
"attachments": [
{
"category": "version",
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"embeddable": true,
"entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"key": "pdf",
"mime": "application/pdf",
"name": "invoice.pdf",
"previous": [
{
"created_at": "2018-01-01T00:00:00.000Z"
}
],
"size": 12345,
"stored": true
}
],
"context": "line.item",
"created_at": "2018-01-01T00:00:00.000Z",
"doc_schema": "https://gobl.org/draft-0/bill/invoice",
"draft": true,
"env_schema": "https://gobl.org/draft-0/envelope",
"faults": [
{
"provider": "pdf"
}
],
"folder": "sales",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"invalid": true,
"key": "invoice-101",
"meta": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"entry_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002:source:key",
"indexed": true,
"key": "service-id",
"link_scope": "public",
"link_url": "https://example.com/info",
"owned": true,
"secure": true,
"shared": true,
"src": "source",
"updated_at": "2018-01-01T00:00:00.000Z",
"value": {
"key": "value"
}
}
],
"signed": true,
"snippet": {
"title": "Sample Title"
},
"state": "sent",
"updated_at": "2018-01-01T00:00:00.000Z"
}
],
"offset": 20,
"query": "FT-101"
}