SMsmokeball
Folders

Get folders/files under root folder

Changed on

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

Folders are listed before files. Paging applies across the combined list: offset defaults to 0 and limit defaults to the maximum page size (PagingOptions.MaxPageSize). Deleted folders and deleted files are excluded.

get/matters/{matterId}/documents/folders

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/documents/folders
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required

Unique identifier of the matter.

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

isDeletedboolean

Flag indicating whether the folder has been deleted. A deleted folder can be restored via PATCH with isDeleted: false.

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",
          "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
          }
        }
      ]
    }
  ],
  "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "name": "Property Documents"
}

Changes

  • db1b8a86b58eRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property //// to the response with the status