API Reference

Files

Endpoints to manage files

File

Properties

NameTypeDescriptionRestrictions
containerstringThe unique identifier of the container that houses the file, such as a folder. If empty, the root folder is the container.
createdActionWhen the action was performed, and details about the user who did itread-only
idstringThe unique identifier of the fileread-only
kindstringKind of the file
modifiedActionWhen the action was performed, and details about the user who did itread-only
namestringName of the file
templatebooleanread-only
typestringType of the fileread-only

Example

{
  "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1QkY2OTA1QjM5QTRCMyZCQkRzQzNDO0FGNB",
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "kind": "Document",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Year-end review",
  "template": false,
  "type": "10-K"
}