Get a file

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "folder": {
    "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c/documents/folders/2c1e8a0d-4b5f-4d2e-8a9b-7c6d5e4f3a2b"
  },
  "matter": {
    "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c"
  },
  "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": {
    "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c/documents/files/b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2/download"
  },
  "additionalData": {
    "source": "Outlook",
    "pageCount": 12,
    "isSigned": true
  },
  "isFavorite": false,
  "isUploaded": false,
  "isCancelled": false,
  "isDuplicate": false,
  "isDeleted": false
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

GET

matters

{matterId}

documents

files

{fileId}

Get a file

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/files/{fileId} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/documents/files/{fileId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "folder": {
    "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c/documents/folders/2c1e8a0d-4b5f-4d2e-8a9b-7c6d5e4f3a2b"
  },
  "matter": {
    "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c"
  },
  "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": {
    "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c/documents/files/b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2/download"
  },
  "additionalData": {
    "source": "Outlook",
    "pageCount": 12,
    "isSigned": true
  },
  "isFavorite": false,
  "isUploaded": false,
  "isCancelled": false,
  "isDuplicate": false,
  "isDeleted": false
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Path Parameters

matterId

string

required

Unique identifier (GUID) of the matter.

fileId

string

required

Unique identifier (GUID) of the file.

Response

When request is successful. Returns a 'File' object.

href

string | null

relation

string | null

method

string | null

default:GET

self

object | null

Show child attributes

string | null

Unique identifier of the file.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

versionId

string | null

Unique identifier of the file's current version. Changes each time new content is uploaded for the file.

Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

folder

object | null

Hypermedia link of the folder to which the file belongs. Null when the file is in the matter's root folder.

Show child attributes

Example:

{
  "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c/documents/folders/2c1e8a0d-4b5f-4d2e-8a9b-7c6d5e4f3a2b"
}

matter

object | null

Hypermedia link of the matter to which the file belongs.

Show child attributes

Example:

{
  "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c"
}

name

string | null

Name of the file, excluding file extension.

Example:

"court filing"

fileExtension

string | null

Extension of the file.

Example:

".pdf"

ownerId

string | null

Unique identifier of the user who created/uploaded this file.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

string | null

The 'To' or recipients' email address (only applicable for email files).

Example:

"recipient@email.com"

from

string | null

The 'From' or sender's email address (only applicable for email files).

Example:

"sender@email.com"

dateCreated

string<date-time>

The original datetime that the file was created.

Example:

"2022-04-23T14:00:00Z"

dateModified

string<date-time>

The datetime that the file was last modified.

Example:

"2022-04-25T17:00:00Z"

sizeBytes

integer<int64>

Size of the file (in bytes).

Example:

19104768

downloadInfo

object | null

Hypermedia link to the download details of the file (a presigned download URL and its expiry).

Show child attributes

Example:

{
  "href": "/matters/f1f9ab2c-3f2a-4a3c-9b6e-0e2d6f6a1b3c/documents/files/b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2/download"
}

additionalData

object | null

Collection of file meta data as key/value pairs. Values may be strings, numbers, booleans or dates.

Show child attributes

Example:

{
  "source": "Outlook",
  "pageCount": 12,
  "isSigned": true
}

isFavorite

boolean

Flag indicating whether this file is a favorite

Example:

false

isUploaded

boolean

Flag indicating whether the file contents are uploaded to the server.

Example:

false

isCancelled

boolean

Flag indicating whether the file upload has been cancelled.

Example:

false

isDuplicate

boolean

Flag indicating whether the file data is duplicated. Applies to emails only for now.

Example:

false

isDeleted

boolean

Flag indicating whether the file has been deleted.

Example:

false

Documentation

Tutorials

APIs

Get a file

Authorizations

Path Parameters

Response