Tutorials
Files and Folders
Create, add and update files and folders
Structure
Every Matter has a familiar folder structure used to store files and documents:
null and if no folder id is specified when adding a File, this is the folder that will be used by default.
Every folder including the root folder, will have a a number of sub-folders and files. When retrieveing a folder from the Folders endpoint you will get a list of the sub-folders and files in that folder. Here is a response for root folder of the Matter shown above:
Creating a Folder
You can create new folders within a matter to organize your files. Creating a folder is done by making a POST request to the folders endpoint.Request Parameters
- name (required): The name of the folder to create. Must be between 1-256 characters.
- parentFolderId (optional): The unique identifier of the parent folder where the new folder should be created.
- userId (optional): The unique identifier of the user creating the folder. If not provided, defaults to the authenticated user.
Parent Folder Behavior
- Root Folder Creation: When
parentFolderIdisnullor not provided, the folder will be created in the root directory of the matter. - Subfolder Creation: When
parentFolderIdis specified with a valid folder ID, the new folder will be created as a subdirectory of that parent folder.
Duplicate Folder Names
The API allows multiple folders with the same name to exist within the same parent directory. If you attempt to create a folder with a name that already exists in the target location, the API will create a new folder with the same name rather than returning an error or the existing folder. This gives you flexibility in organizing your folder structure as needed.Example: Creating a Root Folder
To create a folder in the root directory, omit theparentFolderId or set it to null:
Adding a File
Adding a File to a Matter is a two-step process involving creating the meta-data for the File by POSTing to the files endpoint and then using the response to upload the actual file to the provided URL. Continuing with the Matter example above, if we wanted to add a File to the Correspondence folder we would make the following request:fileId of the new File and an uploadUrl that you can use to upload the actual file to AWS S3 with a PUT request. The uploadUrl will be valid up until the time specified in the expiry field.
For detailed instructions on uploading files using pre-signed S3 URLs, see the AWS documentation on using presigned URLs. The documentation covers request headers, content types, and example code in multiple languages.
Uploading a new version
To upload a new version of a file to an existing File on a Matter you need to get a new upload URL from the files endpoint:uploadUrl that you can use to upload the new version to AWS S3 with a PUT request. The uploadUrl will be valid up until the time specified in the expiry field.
For detailed instructions on uploading files using pre-signed S3 URLs, see the AWS documentation on using presigned URLs. The documentation covers request headers, content types, and example code in multiple languages.
Downloading a File
To download a file you need to make a request to the files endpoint to get a temporarydownloadUrl:
ThedownloadUrlwill be valid up until the time specified in theexpiryfield.