Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- GETGet files on a matter
- POSTAdd file to a matter
- GETGet a file
- PUTUpload/update version or metadata of a file
- DELDelete a file
- PATCHPatch version or metadata of a file
- GETGet download url for a file
- GETGet upload url for a file
- POSTAdd files to a matter
- GETReturns info to preview a file
- POSTCreates a preview request
- GETReturns info to preview a file
- GET
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
Files
Get a file
Retrieves a specified file.
GET
/
matters
/
{matterId}
/
documents
/
files
/
{fileId}
curl --request GET \
--url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId} \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'
{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
"versionId": "<string>",
"folder": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"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,
"downloadInfo": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"additionalData": {},
"isFavorite": false,
"isUploaded": false,
"isCancelled": false,
"isDuplicate": true,
"isDeleted": false
}
Response
200
application/json
When request is successful. Returns a 'File' object.
The response is of type object
.
curl --request GET \
--url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId} \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'
{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
"versionId": "<string>",
"folder": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"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,
"downloadInfo": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "<string>"
},
"additionalData": {},
"isFavorite": false,
"isUploaded": false,
"isCancelled": false,
"isDuplicate": true,
"isDeleted": false
}
Assistant
Responses are generated using AI and may contain mistakes.