GET
/
matters
/
{matterId}
/
documents
/
folders
Get folders/files under root folder
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/folders \
  --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": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "folders": [
        {
          "href": "<string>",
          "relation": "<string>",
          "method": "GET",
          "self": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "<string>"
          },
          "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
          "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
          "name": "Property Documents"
        }
      ],
      "files": [
        {
          "href": "<string>",
          "relation": "<string>",
          "method": "GET",
          "self": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "<string>"
          },
          "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
          "versionId": "<string>",
          "folder": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "<string>"
          },
          "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,
          "downloadInfo": {
            "id": "<string>",
            "href": "<string>",
            "relation": "<string>",
            "method": "<string>"
          },
          "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": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "name": "Property Documents"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
matterId
string
required

Query Parameters

​
Offset
integer
Required range: 0 <= x <= 2147483647
​
Limit
integer
Required range: 1 <= x <= 500

Response

200 - application/json

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

The response is of type object.