Search entries
Perform a free-text search on all documents in the current company.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Search query string.
Folder to search within.
Maximum number of entries to show in a page of results.
The number of entries to skip in the result set.
curl --request GET \
--url https://api.invopop.com/silo/v1/search{
"folder": "sales",
"limit": 20,
"list": [
{
"attachments": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"id": "<string>",
"meta": {},
"mime": "application/pdf",
"name": "invoice.pdf",
"size": 12345,
"stored": true,
"url": "<string>"
}
],
"context": "line.item",
"created_at": "2018-01-01T00:00:00.000Z",
"data": "<any>",
"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",
"invalid": true,
"meta": {},
"snippet": "<any>",
"state": "sent",
"tags": [
"<string>"
],
"updated_at": "2018-01-01T00:00:00.000Z"
}
],
"offset": 20,
"query": "FT-101"
}Query Parameters
Search query string.
Folder to search within.
Maximum number of entries to show in a page of results.
The number of entries to skip in the result set.
Response
Key for the folder
Maximum number of entries to show in a page of results, up to 100.
Array of entries.
List of attachments for this entry.
The date and time this attachment was created.
Description of the file.
SHA256 hash of the file.
The UUID that identifies the attachment.
Any additional meta data about the attachment.
MIME type of the file.
Name of the file.
Size of the file in bytes.
When true, indicates that the file's contents have been uploaded successfully.
URL where the file's contents can be downloaded.
When entry provided within a related query, this is the context within the document.
The date and time the silo entry was created.
JSON envelope contents when specifically requested.
Schema URL for the envelope's payload.
When true, indicates that the envelope is a draft.
Schema URL for the envelope.
Key for the folder where the entry is located.
UUID of the silo entry.
When true, the envelope's contents are invalid and need to be reviewed.
JSON object containing a snippet of the document.
Current state of the silo entry if not a draft.
The date and time the silo entry was last updated.
Number of entries to skip in the result set.
String query used for the search.
curl --request GET \
--url https://api.invopop.com/silo/v1/search{
"folder": "sales",
"limit": 20,
"list": [
{
"attachments": [
{
"created_at": "2018-01-01T00:00:00.000Z",
"desc": "Invoice for January 2021.",
"hash": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"id": "<string>",
"meta": {},
"mime": "application/pdf",
"name": "invoice.pdf",
"size": 12345,
"stored": true,
"url": "<string>"
}
],
"context": "line.item",
"created_at": "2018-01-01T00:00:00.000Z",
"data": "<any>",
"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",
"invalid": true,
"meta": {},
"snippet": "<any>",
"state": "sent",
"tags": [
"<string>"
],
"updated_at": "2018-01-01T00:00:00.000Z"
}
],
"offset": 20,
"query": "FT-101"
}