v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

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

Query parameters

Offsetinteger

Limitinteger

Request body

querystring required

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

Example request

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

Response

Returns the matching files.

{"stackTrail":"paths:/search/files:post:responses:200:content:application/json:schema:items","oasType":"schema","type":"unknown"}