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"
    ]
  }
}
'

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

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.