Search files with advanced filters

Performs a full-account file search and returns files matching the provided query, paging options and filters.

POST /search/files

Search files with advanced filters

cURL

curl --request POST \
  --url https://api.smokeball.com/search/files \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "contract",
  "filters": {
    "searchFields": [
      "Name",
      "Content"
    ],
    "includeFileExtensions": [
      "pdf",
      "docx"
    ],
    "excludeFileExtensions": [
      "tmp",
      "bak"
    ],
    "authorIds": [
      "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
    ],
    "contactIds": [
      "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"
    ]
  }
}
'

import requests

url = "https://api.smokeball.com/search/files"

payload = {
    "query": "contract",
    "filters": {
        "searchFields": ["Name", "Content"],
        "includeFileExtensions": ["pdf", "docx"],
        "excludeFileExtensions": ["tmp", "bak"],
        "authorIds": ["750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"],
        "contactIds": ["b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"]
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    query: 'contract',
    filters: {
      searchFields: ['Name', 'Content'],
      includeFileExtensions: ['pdf', 'docx'],
      excludeFileExtensions: ['tmp', 'bak'],
      authorIds: ['750eb5c5-ac0b-7d11-4997-e0ce9d8896c8'],
      contactIds: ['b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2']
    }
  })
};

fetch('https://api.smokeball.com/search/files', 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.smokeball.com/search/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => 'contract',
    'filters' => [
        'searchFields' => [
                'Name',
                'Content'
        ],
        'includeFileExtensions' => [
                'pdf',
                'docx'
        ],
        'excludeFileExtensions' => [
                'tmp',
                'bak'
        ],
        'authorIds' => [
                '750eb5c5-ac0b-7d11-4997-e0ce9d8896c8'
        ],
        'contactIds' => [
                'b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.smokeball.com/search/files"

	payload := strings.NewReader("{\n  \"query\": \"contract\",\n  \"filters\": {\n    \"searchFields\": [\n      \"Name\",\n      \"Content\"\n    ],\n    \"includeFileExtensions\": [\n      \"pdf\",\n      \"docx\"\n    ],\n    \"excludeFileExtensions\": [\n      \"tmp\",\n      \"bak\"\n    ],\n    \"authorIds\": [\n      \"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8\"\n    ],\n    \"contactIds\": [\n      \"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.smokeball.com/search/files")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"query\": \"contract\",\n  \"filters\": {\n    \"searchFields\": [\n      \"Name\",\n      \"Content\"\n    ],\n    \"includeFileExtensions\": [\n      \"pdf\",\n      \"docx\"\n    ],\n    \"excludeFileExtensions\": [\n      \"tmp\",\n      \"bak\"\n    ],\n    \"authorIds\": [\n      \"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8\"\n    ],\n    \"contactIds\": [\n      \"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/search/files")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"query\": \"contract\",\n  \"filters\": {\n    \"searchFields\": [\n      \"Name\",\n      \"Content\"\n    ],\n    \"includeFileExtensions\": [\n      \"pdf\",\n      \"docx\"\n    ],\n    \"excludeFileExtensions\": [\n      \"tmp\",\n      \"bak\"\n    ],\n    \"authorIds\": [\n      \"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8\"\n    ],\n    \"contactIds\": [\n      \"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2\"\n    ]\n  }\n}"

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

200

[
  "<unknown>"
]

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Query Parameters

Offset · integer<int32>

Required range: 0 <= x <= 2147483647

Limit · integer<int32>

Required range: 1 <= x <= 500

Body

application/json-patch+jsonapplication/jsonapplication/*+json

query · string · required

Full-text search expression. Required and non-empty.

Minimum string length: 1

Example:

"contract"

filters · object | null

Filters narrowing the search to specific extensions, date ranges, authors, contacts, and which fields to match against.

Show child attributes

Response

200

application/json

Returns the matching files.