Skip to main content
A set of endpoints used to manage archives.

​
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.
PropertyTypeRequiredDescription
idstringYesThe unique identifier that represents an archive.
typeenum<string>YesThe value is always archive. Available options: archive.
namestringYesThe 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.
sizeintegerYesThe size of the archive in bytes.
descriptionstringNoThe description of the archive. Can be null.
owned_byobjectNoThe part of an archive API response that describes the user who owns the archive.
Example
{
  "id": "12345",
  "type": "archive",
  "name": "Archive",
  "size": 123456789,
  "description": "This is an archive for important documents.",
  "owned_by": {
    "id": "12345",
    "type": "user"
  }
}

​
Archives

A list of archives.
PropertyTypeRequiredDescription
entriesarray of ArchiveNoA list in which each entry represents an archive object.
limitintegerNoThe limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
next_markerstringNoThe marker for the start of the next page of results. Can be null.
Example
{
  "entries": [
    {
      "id": "12345",
      "type": "archive",
      "name": "Archive",
      "size": 123456789,
      "description": "This is an archive for important documents.",
      "owned_by": {
        "id": "12345",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
Last modified on July 9, 2026