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}

Get preview info for a file by document version

cURL

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}/preview/{documentVersionId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

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

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

matterId · string · required

fileId · string · required

documentVersionId · string · required

Response

200

application/json

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

fileId · string | null

Unique identifier of the requested file

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

documentVersionId · string | null

downloadUrl · string | null

Temporary Link to download file

Example:

""

expiry · string<date-time> | null

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

Example:

"2022-04-23T14:30:00Z"