Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Files

Get preview info for a file by document version

Returns info to preview a file by document version.

get/matters/{matterId}/documents/files/{fileId}/preview/{documentVersionId}

Path parameters

matterIdstring required
fileIdstring required
documentVersionIdstring required

Response

When request is successful. Returns a 'PreviewFileInfo' object.

fileIdstring nullable

Unique identifier of the requested file

documentVersionIdstring nullable
downloadUrlstring nullable

Temporary Link to download file

expirystring date-time nullable

Expiry date/time when the download link is no longer accessible

Example response

{
  "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "expiry": "2022-04-23T14:30:00Z"
}