Sign in
Files

Get files on a matter

Returns a paged list of files associated with a matter. Deleted files are excluded.

Paging defaults: offset 0, limit equal to the maximum page size when not supplied.

Ordering: ascending by date created (oldest first) unless a sort option is supplied.

Three query modes are used depending on the supplied options:

  • Search (a search query is supplied): results come from the document search index. Sort, paging and the cursor all apply.
  • Cursor only (no search query): returns files modified since the cursor. Sort options are ignored in this mode.
  • Standard (neither): sort, paging and file extension include/exclude filters apply.
get/matters/{matterId}/documents/files

Path parameters

matterIdstring required

Unique identifier (GUID) of the matter.

Query parameters

Offsetinteger
Limitinteger
Cursorstring
Sortstring

Available fields: dateCreated

Searchstring[]

Available fields: query, fileExtension

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "versionId": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "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,
      "additionalData": {
        "source": "Outlook",
        "pageCount": 12,
        "isSigned": true
      }
    }
  ]
}

Changes