v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Folders

Get folders/files under root folder

Returns a list of sub folders and files under the root folder of a matter.

get/matters/{matterId}/documents/folders

Path parameters

matterIdstring required

Query parameters

Offsetinteger

Limitinteger

Response

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

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

offsetinteger nullable

limitinteger nullable

sizeinteger

parentIdstring nullable

Unique identifier of the parent folder

namestring nullable

Name of the folder

Example response

{
  "value": [
    {
      "folders": [
        {
          "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
          "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
          "name": "Property Documents"
        }
      ],
      "files": [
        {
          "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
          "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
        }
      ]
    }
  ],
  "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "name": "Property Documents"
}