Get files on a matter

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

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "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"
      },
      "name": "court filing",
      "fileExtension": ".pdf",
      "ownerId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "to": "[email protected]",
      "from": "[email protected]",
      "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
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

GET

matters

{matterId}

documents

files

Get files on a matter

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

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "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"
      },
      "name": "court filing",
      "fileExtension": ".pdf",
      "ownerId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "to": "[email protected]",
      "from": "[email protected]",
      "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
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Path Parameters

matterId

string

required

Query Parameters

Offset

integer<int32>

Required range: 0 <= x <= 2147483647

Limit

integer<int32>

Required range: 1 <= x <= 500

Cursor

string

Response

When request is successful. Returns a paged collection of 'File' objects.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

Show child attributes

self.id

string | null

self.href

string | null

self.relation

string | null

self.method

string | null

default:GET

value

object[] | null

Show child attributes

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

Show child attributes

value.self.id

string | null

value.self.href

string | null

value.self.relation

string | null

value.self.method

string | null

default:GET

value.id

string | null

Unique identifier of the file.

Example:

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

value.versionId

string | null

Unique identifier of the file's current version.

value.folder

object

Hypermedia link of the folder to which the file belongs.

Show child attributes

value.folder.id

string | null

value.folder.href

string | null

value.folder.relation

string | null

value.folder.method

string | null

default:GET

value.name

string | null

Name of the file, excluding file extension.

Example:

"court filing"

value.fileExtension

string | null

Extension of the file.

Example:

".pdf"

value.ownerId

string | null

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

Example:

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

value.to

string | null

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

Example:

"[email protected]"

value.from

string | null

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

Example:

"[email protected]"

value.dateCreated

string<date-time>

The original datetime that the file was created.

Example:

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

value.dateModified

string<date-time>

The datetime that the file was last modified.

Example:

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

value.sizeBytes

integer<int64>

Size of the file (in bytes).

Example:

19104768

value.downloadInfo

object

Hypermedia link to the download details of the file.

Show child attributes

value.downloadInfo.id

string | null

value.downloadInfo.href

string | null

value.downloadInfo.relation

string | null

value.downloadInfo.method

string | null

default:GET

value.additionalData

object

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

Show child attributes

value.additionalData.{key}

unknown

value.isFavorite

boolean

Flag indicating whether this file is a favorite

Example:

false

value.isUploaded

boolean

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

Example:

false

value.isCancelled

boolean

Flag indicating whether the file upload has been cancelled.

Example:

false

value.isDuplicate

boolean

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

value.isDeleted

boolean

Flag indicating whether the file has been deleted.

Example:

false

offset

integer<int32> | null

limit

integer<int32> | null

size

integer<int64>

first

object

Show child attributes

first.id

string | null

first.href

string | null

first.relation

string | null

first.method

string | null

default:GET

object

Show child attributes

previous.id

string | null

previous.href

string | null

previous.relation

string | null

previous.method

string | null

default:GET

object

Show child attributes

next.id

string | null

next.href

string | null

next.relation

string | null

next.method

string | null

default:GET

last

object

Show child attributes

last.id

string | null

last.href

string | null

last.relation

string | null

last.method

string | null

default:GET

Patch a fee Add file to a matter

⌘I

Documentation

Tutorials

APIs

Get files on a matter

Authorizations

Path Parameters

Query Parameters

Response