Shares represent the "Send File" and "Request File" actions initiated by ShareFile users. Shares allows users to give temporary access to specific set of files or folders, allowing other users to download or upload files even though they would not have permissions otherwise.
| Name | Type | Description |
| AliasID | String | When a Share is sent to multiple users, with RequireLogin or RequireUserInfo set, then a different Share Alias is created for each user. The email ShareFile sends to these users will contain different AliasIDs, allowing ShareFile to track the user activity on the share. For anonymous Shares, the AliasID will be the same as the Share ID. |
| ShareType | ShareType | Either "Send" or "Request". Send Shares are used to Send files and folders to the specified users. Request shares are used to allow users to upload files to the share owner chosen location. |
| Title | String | Share title |
| HasSentMessage | Boolean | Flag to indicate if ShareFile has sent email messages for this Share |
| SentMessageTitle | String | Subject of Share email message |
| RequireLogin | Boolean | If set, only authenticated users can download files from this share. |
| RequireUserInfo | Boolean | If set, users must provide Name, Email and Company information to download files from the share. |
| Parent | Item | Folder location that contain the share files (Send); or the folder were files will be uploaded to (Request). |
| Creator | User | User that created this Share. |
| User | User | User given permission to use this share - used for Aliases. |
| Items | List of Item | List of shared Items (for Send Shares only) |
| CreationDate | DateTime | Date the share was created |
| ExpirationDate | DateTime | Date the share expires |
| MaxDownloads | Int32 | Maximum number of downloads each user can perform. |
| TotalDownloads | Int32 | Total number of times a share has been downloaded by a user. |
| IsViewOnly | Boolean | Indicates the files in the share can only be viewed, but not downloaded |
| TrackUntilDate | DateTime | User activity on this share will be tracked up to this date. |
| IsConsumed | Boolean | Indicates whether or not this Share has been downloaded |
| IsRead | Boolean | Indicates whether the contents of this share have been viewed by a valid, authenticated recipient |
| UsesStreamIDs | Boolean | When enabled the items are identified by stream IDs instead of item IDs. Applies to Send Shares only. |
| Uri | Uri | Uri to access the share through the Web portal |
| Recipients | List of ShareAlias | List of users that have access to this share. |
| Zone | Zone | The Storage Zone that contains this Share. |
| Signature | String | HMAC Signature for the Share data |
| HasRemoteChildren | Boolean | Defines whether the request to retrieve Share Items is to be navigated to a remote endpoint. |
| Redirection | Redirection | Redirection endpoint for this Share. |
| ShareItemHistory | List of ShareItemHistory | Shared item history. |
| Settings | ShareSettings | Current Settings for the Share |
| ShareAccessRight | ShareAccessRight | Type of the Share |
| IsPersistentLink | Boolean | Indicates whether or not a share is a persistent link Applies to Send Shares only. |
| PersistentLinkTargetID | String | Target ID of file or stream being shared via this persistent link. Applies to persistent link shares only. Applies to Send Shares only. |
| PersistentLinkTargetCreationDate | DateTimeOffset | Creation date of the version of the file being shared via this persistent link. Applies to persistent link shares with UsesStreamIDs set to false only. Applies to Send Shares only. |