Get files on a matter

Returns a list of files associated with a matter. Defaults to ascending order of date created, i.e. oldest first, unless sort option is supplied. Custom sorting and searching options does not apply to cursor-based pagination.

GET /matters/{matterId}/documents/files

Get files on a matter

cURL

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

200

{
  "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": "[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
    }
  ],
  "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

Sort · string

Available fields: dateCreated

Search · string[]

Available fields: query, fileExtension

Response

200

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes

offset · integer<int32> | null

limit · integer<int32> | null

size · integer<int64>

first · object

Show child attributes

previous · object

Show child attributes

next · object

Show child attributes

last · object

Show child attributes