Entries
Search entries
Perform a free-text search on all documents in the current company.
GET
/
silo
/
v1
/
search
Authorization
Query
curl --request GET \
--url https://api.invopop.com/silo/v1/search \
--header 'Authorization: Bearer <token>'
{
"folder": "sales",
"limit": "20",
"list": [
{
"attachments": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"id": "string",
"meta": "object",
"mime": "application/pdf",
"name": "invoice.pdf",
"size": "12345",
"stored": true,
"url": "string"
}
],
"created_at": "2018-01-01T00:00:00.000Z",
"digest": {
"alg": "string",
"val": "string"
},
"doc_schema": "https://gobl.org/draft-0/bill/invoice",
"draft": true,
"env_schema": "https://gobl.org/draft-0/envelope",
"folder": "sales",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"meta": "object",
"tags": [
"string"
],
"updated_at": "2018-01-01T00:00:00.000Z"
}
],
"offset": "20",
"query": "FT-101"
}
Query Parameters
qrequired
string
Search query string.
folder
string
Folder to search within.
limit
integer
Maximum number of entries to show in a page of results.
offset
integer
The number of entries to skip in the result set.
Response
200 - application/json
folder
string
Key for the folder
limit
integer
Maximum number of entries to show in a page of results, up to 100.
list
object[] | null
Array of entries.
offset
integer
Number of entries to skip in the result set.
query
string
String query used for the search.
curl --request GET \
--url https://api.invopop.com/silo/v1/search \
--header 'Authorization: Bearer <token>'
{
"folder": "sales",
"limit": "20",
"list": [
{
"attachments": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"id": "string",
"meta": "object",
"mime": "application/pdf",
"name": "invoice.pdf",
"size": "12345",
"stored": true,
"url": "string"
}
],
"created_at": "2018-01-01T00:00:00.000Z",
"digest": {
"alg": "string",
"val": "string"
},
"doc_schema": "https://gobl.org/draft-0/bill/invoice",
"draft": true,
"env_schema": "https://gobl.org/draft-0/envelope",
"folder": "sales",
"id": "347c5b04-cde2-11ed-afa1-0242ac120002",
"meta": "object",
"tags": [
"string"
],
"updated_at": "2018-01-01T00:00:00.000Z"
}
],
"offset": "20",
"query": "FT-101"
}