Box Developer Documentation
Log in

Archive

An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its owner and collaborators. To use this feature, you must request GCM scope for your Box application.

string
12345

The unique identifier that represents an archive.

string
archive

The value is always archive.

Value is always archive

string
This is an archive for important documents.
255

The description of the archive.

string
Archive
100

The name of the archive.

The following restrictions to the archive name apply: names containing non-printable ASCII characters, forward and backward slashes (/, \), names with trailing spaces, and names . and .. are not allowed.

object
{"id":"12345","type":"user"}

The part of an archive API response that describes the user who owns the archive.

string
12345

The unique identifier that represents a user who owns the archive.

string
user

The value is always user.

integer (int64)
123456789

The size of the archive in bytes.

Response Example

{
  "id": "12345",
  "type": "archive",
  "description": "This is an archive for important documents.",
  "name": "Archive",
  "owned_by": {
    "id": "12345",
    "type": "user"
  },
  "size": 123456789
}