Box Developer Documentation
Log in
Latest version

List archives

get
https://api.box.com/2.0
/archives

Retrieves archives for an enterprise.

To learn more about the archive APIs, see the Archive API Guide.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

Response

application/jsonArchives

Returns a list of archives in the enterprise.

application/jsonClient error

Returns an error if some of the parameters are missing or not valid.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returns an error if the authenticated user does not have the right permissions to list archives.

application/jsonClient error

An unexpected server error.

application/jsonClient error

An unexpected client error.

get
List archives
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/archives" \
     -H "box-version: 2025.0" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.archives.getArchivesV2025R0({
  limit: 100,
} satisfies GetArchivesV2025R0QueryParams);
Python v10
client.archives.get_archives_v2025_r0(limit=100)
.NET v10
await client.Archives.GetArchivesV2025R0Async(queryParams: new GetArchivesV2025R0QueryParams() { Limit = 100 });
Swift v10
try await client.archives.getArchivesV2025R0(queryParams: GetArchivesV2025R0QueryParams(limit: Int64(100)))
Java v10
client.getArchives().getArchivesV2025R0(new GetArchivesV2025R0QueryParams.Builder().limit(100L).build())

Response Example

{
  "entries": [
    {
      "id": "12345",
      "name": "Archive",
      "size": 123456789,
      "type": "archive"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}