Skip to main content
GET
Get a file

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

fileId
string<uuid>
required

Query Parameters

download
boolean

Response

File metadata (v2)

File representation that splits the former fileType field into two: tag (owner-specific document tag) and fileType (owner-agnostic canonical Slate type). Use FileV2 (via the /v2 endpoints) for any new integration. The v1 File schema is retained for backwards compatibility and continues to carry the document tag in its fileType field.

id
string<uuid>
required
matterId
string<uuid>
required
owner
string
required
status
enum<string>
required
Available options:
active,
archived
uploadStatus
enum<string>
required
Available options:
pending,
uploaded
fileName
string
required
crid
string
required
key
string
description
string
uploadedOn
string<date-time>
downloadUrl
string<uri>
creditorCreationDate
string<date-time>
uploadedBy
string
lastViewed
string<date-time>
lastViewedBy
string
lastDownloaded
string<date-time>
lastDownloadedBy
string
tag
string

Owner-specific document tag. Stable per file.

fileType
string

Owner-agnostic canonical Slate file type (e.g. REPAYMENT_AGREEMENT). Prefer this for routing and filtering; absent when the file has not yet been mapped to a canonical type.

metadata
object | null

Optional metadata associated with the file

fileAttributes
object

Per-file statistics computed asynchronously after upload. Absent until the file has been analyzed. PDF-structural stats nest under the application/pdf key; sizeBytes and contentType are general and apply to any analyzed file.

redactionSummary
object

Per-file aggregate of redaction jobs. Only present on File responses when ?redactionSummary=true is set and the file has at least one redaction. latestStatus reflects the most recently created job.