Search entries

Perform a free-text search on all documents in the current company.

GET /silo/v1/search

cURL

cURL

curl --request GET \
  --url https://api.invopop.com/silo/v1/search \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.invopop.com/silo/v1/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.invopop.com/silo/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.invopop.com/silo/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.invopop.com/silo/v1/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.invopop.com/silo/v1/search")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.invopop.com/silo/v1/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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",
          "id": "<string>",
          "key": "pdf",
          "meta": {},
          "mime": "application/pdf",
          "name": "invoice.pdf",
          "previous": [
            {
              "created_at": "2018-01-01T00:00:00.000Z",
              "hash": "<string>",
              "id": "<string>",
              "size": 123
            }
          ],
          "private": true,
          "size": 12345,
          "stored": true,
          "url": "<string>"
        }
      ],
      "context": "line.item",
      "created_at": "2018-01-01T00:00:00.000Z",
      "data": {},
      "digest": {
        "alg": "<string>",
        "val": "<string>"
      },
      "doc_schema": "https://gobl.org/draft-0/bill/invoice",
      "draft": true,
      "env_schema": "https://gobl.org/draft-0/envelope",
      "faults": [
        {
          "code": "<string>",
          "message": "<string>",
          "paths": [
            "<string>"
          ],
          "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,
          "owner_id": "<string>",
          "ref": "<string>",
          "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",
      "tags": [
        "<string>"
      ],
      "updated_at": "2018-01-01T00:00:00.000Z"
    }
  ],
  "offset": 20,
  "query": "FT-101"
}

Authorizations

Authorization · string · header · required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Query Parameters

q · string · required

Search query string.

Example:

"TEST"

folder · string

Folder to search within.

Example:

"invoices"

limit · integer

Maximum number of entries to show in a page of results.

Example:

20

offset · integer

The number of entries to skip in the result set.

Example:

10

Response

200 - application/json

OK

folder · string

Key for the folder

Example:

"sales"

limit · integer

Maximum number of entries to show in a page of results, up to 100.

Example:

20

list · List · object[] | null

Array of entries ordered by relevance.

Show child attributes

offset · integer

Number of entries to skip in the result set.

Example:

20

query · string

String query used for the search.

Example:

"FT-101"