Get a file

Retrieves a specified file.

GET /matters/{matterId}/documents/files/{fileId}

Get a file

cURL

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

200

{
  "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": "GET"
  },
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "name": "court filing",
  "fileExtension": ".pdf",
  "ownerId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "to": "[e-mail]",
  "from": "[e-mail]",
  "dateCreated": "2022-04-23T14:00:00Z",
  "dateModified": "2022-04-25T17:00:00Z",
  "sizeBytes": 19104768,
  "downloadInfo": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "additionalData": {},
  "isFavorite": false,
  "isUploaded": false,
  "isCancelled": false,
  "isDuplicate": true,
  "isDeleted": false
}

{
  "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

fileId · string · required

matterId · string · required

Response

200

application/json

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

id · string | null

Unique identifier of the file.

Example:

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

versionId · string | null

Unique identifier of the file's current version.

folder · object | null

Hypermedia link of the folder to which the file belongs.

Show child attributes

matter · object | null

Hypermedia link of the matter to which the file belongs.

Show child attributes

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"

to · string | null

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

Example:

"[e-mail]"

from · string | null

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

Example:

"[e-mail]"

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.

Show child attributes

additionalData · object | null

Collection of file meta data as KeyValuePair(string, object).

Show child attributes

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.

isDeleted · boolean

Flag indicating whether the file has been deleted.

Example:

false