Skip to content

Get files

Request

Retrieve a list of file resources (File, Folder, ContractDocument)

Recursive behavior:

  • When filtering by Folder.Id (parent folder): recursive=false by default (returns direct children only)
  • When no folder filter is specified: recursive=true by default (returns all files/folders)
  • Use the recursive query parameter to explicitly override these defaults

Examples:

  • GET /v2/files?$filter=Folder/Id eq 786 (direct children only)
  • GET /v2/files?$filter=Folder/Id eq 786&recursive=true (include nested descendants)
  • GET /v2/files?$filter=Type eq 'Folder' (folders only)

Filtering:

  • Only a single Folder.Id filter is allowed per request
  • Results are automatically filtered to include only Matter and Contract file types
Query
$filterstring

Filter the results using OData filter syntax

$orderbystring

Order the results using OData orderby syntax

$skipinteger

Skip the specified number of results

$topinteger

Limit the number of results returned

recursiveboolean

Specifies if child files and folders should be returned

const resp = await fetch(
  `https://api-sandbox.lawvu.com/v2/files`,
  {method: 'GET'}
);

const data = await resp.text();
console.log(data);

Responses

OK

Bodyapplication/json
itemsArray of objects(File)

The collection of items

Response
{
  "items": [
    { … }
  ]
}