Get trashed file

v1.0.0

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the GET /folders/:id/trash [blocked] API.

To list all items that have been moved to the trash, please use the GET /folders/trash/items [blocked] API.

Input

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "file_id": {
      "type": "string"
    }
  },
  "required": [
    "file_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Represents a trashed file.",
  "required": [
    "created_at",
    "description",
    "id",
    "item_status",
    "modified_at",
    "modified_by",
    "owned_by",
    "path_collection",
    "sequence_id",
    "sha1",
    "size",
    "type"
  ],
  "properties": {
    "content_created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which this file was originally\ncreated, which might be before it was uploaded to Box."
    },
    "content_modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which this file was last updated,\nwhich might be before it was uploaded to Box."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the file was created on Box."
    },
    "created_by": {
      "type": "object"
    },
    "description": {
      "type": "string",
      "description": "The optional description of this file"
    },
    "etag": {
      "type": "string",
      "description": "The HTTP `etag` of this file. This can be used within some API\nendpoints in the `If-Match` and `If-None-Match` headers to only\nperform changes on the file if (no) changes have happened."
    },
    "file_version": {
      "type": "object"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier that represent a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`."
    },
    "item_status": {
      "type": "string",
      "description": "Defines if this item has been deleted or not.\n\n* `active` when the item has is not in the trash\n* `trashed` when the item has been moved to the trash but not deleted\n* `deleted` when the item has been permanently deleted.",
      "enum": [
        "active",
        "trashed",
        "deleted"
      ]
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the file was last updated on Box."
    },
    "modified_by": {
      "type": "object"
    },
    "name": {
      "type": "string",
      "description": "The name of the file"
    },
    "owned_by": {
      "type": "object"
    },
    "parent": {
      "type": "object"
    },
    "path_collection": {
      "type": "object"
    },
    "purged_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time at which this file is expected to be purged\nfrom the trash."
    },
    "sequence_id": {
      "type": "object"
    },
    "sha1": {
      "type": "string",
      "format": "digest",
      "description": "The SHA1 hash of the file. This can be used to compare the contents\nof a file on Box with a local file."
    },
    "shared_link": {
      "type": "string",
      "description": "The shared link for this file. This will\nbe `null` if a file has been trashed, since the link will no longer\nbe active."
    },
    "size": {
      "type": "integer",
      "description": "The file size in bytes. Be careful parsing this integer as it can\nget very large and cause an integer overflow."
    },
    "trashed_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time at which this file was put in the trash."
    },
    "type": {
      "type": "string",
      "description": "`file`",
      "enum": [
        "file"
      ]
    }
  }
}