GET
/
matters
/
{matterId}
/
documents
/
files
/
{fileId}
/
download
Get download url for a file
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}/download \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "fileId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "name": "court filing",
  "fileExtension": ".pdf",
  "downloadUrl": "",
  "expiry": "2022-04-23T14:30:00Z",
  "sizeBytes": 19104768
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
matterId
string
required
​
fileId
string
required

Query Parameters

​
versionId
string

Response

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

​
fileId
string | null

Unique identifier of the requested file

Example:

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

​
name
string | null

Name of the file, excluding file extension.

Example:

"court filing"

​
fileExtension
string | null

Extension of the file.

Example:

".pdf"

​
downloadUrl
string | null

Temporary Link to download file

Example:

""

​
expiry
string<date-time>

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

Example:

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

​
sizeBytes
integer

Size of the requested file (in bytes)

Example:

19104768