Files
List Files
Returns the authenticated customer’s files and documents.
GET
List Files
Returns the list of files and documents associated with the authenticated customer’s account, including contracts, agreements, and uploaded documents.Authentication
Requires a valid customer bearer token.Query Parameters
Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation.
Response
Returns an array of file objects with the following fields.File Fields
Identity
| Field | Type | Description |
|---|---|---|
Id | number | Unique numeric identifier for the file |
UniqueId | string | Globally unique identifier |
Core
| Field | Type | Description |
|---|---|---|
Name | string | File display name |
Description | string | File description |
BusinessName | string | Location that owns the file |
Signed | boolean | Whether the document has been signed |
RequestDigitalSignature | boolean | Whether a digital signature is required |
ProposalUniqueId | string | null | Linked proposal GUID (if applicable) |
Timestamps (from base)
| Field | Type | Description |
|---|---|---|
CreatedOn | string | Date created (business-local time) |
UpdatedOn | string | null | Date last updated (business-local time) |
CreatedOnUtc | string | Date created (UTC) |
UpdatedOnUtc | string | null | Date last updated (UTC) |