Skip to main content
API version 2025.0 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.
​
id
string
example: 12345The unique identifier that represents an archive.
​
type
string
example: archiveThe value is always archive.Value is always archive
​
description
string
example: This is an archive for important documents.The description of the archive.
​
name
string
example: ArchiveThe 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.
​
owned_by
object
example: {"id":"12345","type":"user"}The part of an archive API response that describes the user who owns the archive.
​
size
integer(int64)
example: 123456789The size of the archive in bytes.
{
  "id": "12345",
  "type": "archive",
  "description": "This is an archive for important documents.",
  "name": "Archive",
  "owned_by": {
    "id": "12345",
    "type": "user"
  },
  "size": 123456789
}