SMsmokeball
Files

Get a file

Changed on

Retrieves a specified file. The file must belong to the matter in the route.

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

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required

Unique identifier (GUID) of the matter.

fileIdstring required

Unique identifier (GUID) of the file.

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the file.

versionIdstring nullable

Unique identifier of the file's current version. Changes each time new content is uploaded for the file.

namestring nullable

Name of the file, excluding file extension.

fileExtensionstring nullable

Extension of the file.

ownerIdstring nullable

Unique identifier of the user who created/uploaded this file.

tostring nullable

The 'To' or recipients' email address (only applicable for email files).

fromstring nullable

The 'From' or sender's email address (only applicable for email files).

dateCreatedstring date-time

The original datetime that the file was created.

dateModifiedstring date-time

The datetime that the file was last modified.

sizeBytesinteger

Size of the file (in bytes).

additionalDataobject nullable

Collection of file meta data as key/value pairs. Values may be strings, numbers, booleans or dates.

isFavoriteboolean

Flag indicating whether this file is a favorite

isUploadedboolean

Flag indicating whether the file contents are uploaded to the server.

isCancelledboolean

Flag indicating whether the file upload has been cancelled.

isDuplicateboolean

Flag indicating whether the file data is duplicated. Applies to emails only for now.

isDeletedboolean

Flag indicating whether the file has been deleted.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "name": "court filing",
  "fileExtension": ".pdf",
  "ownerId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "to": "recipient@email.com",
  "from": "sender@email.com",
  "dateCreated": "2022-04-23T14:00:00Z",
  "dateModified": "2022-04-25T17:00:00Z",
  "sizeBytes": 19104768,
  "additionalData": {
    "source": "Outlook",
    "pageCount": 12,
    "isSigned": true
  }
}

Changes