> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Download ZIP Archive

export const Link = ({href, children, className, ...props}) => {
  const localizedHref = localizeLink(href);
  return <a href={localizedHref} className={className} {...props}>
      {children}
    </a>;
};

export const MultiRelatedLinks = ({sections = []}) => {
  if (!sections || sections.length === 0) {
    return null;
  }
  return <div className="space-y-8">
      {sections.map((section, index) => <RelatedLinks key={index} title={section.title} items={section.items} />)}
    </div>;
};

export const RelatedLinks = ({title, items = []}) => {
  const getBadgeClass = badge => {
    if (!badge) return "badge-default";
    const badgeType = badge.toLowerCase().replace(/\s+/g, "-");
    return `badge-${badge === "ガイド" ? "guide" : badgeType}`;
  };
  if (!items || items.length === 0) {
    return null;
  }
  return <div className="my-8">
      {}
      <h3 className="text-sm font-bold uppercase tracking-wider mb-4">{title}</h3>

      {}
      <div className="flex flex-col gap-3">
        {items.map((item, index) => <a key={index} href={item.href} className="py-2 px-3 rounded related_link hover:bg-[#f2f2f2] dark:hover:bg-[#111827] flex items-center gap-3 group no-underline hover:no-underline border-b-0">
            {}
            <span className={`px-2 py-1 rounded-full text-xs font-semibold uppercase tracking-wide flex-shrink-0 ${getBadgeClass(item.badge)}`}>
              {item.badge}
            </span>

            {}
            <span className="text-base">{item.label}</span>
          </a>)}
      </div>
    </div>;
};

To download all files in a folder or an entire folder structure, you have to create and download a ZIP archive.

## Create a ZIP Archive

First, you need to create a ZIP archive containing the files or the folder structure. You can include up to 10,000 file and folder IDs unless you reach the account’s upload limit.

<CodeGroup>
  ```sh cURL theme={null}
  curl -i -X POST "https://api.box.com/2.0/zip_downloads" \
       -H "authorization: Bearer <ACCESS_TOKEN>" \
       -d '{
         "download_file_name": "January Financials",
         "items": [
           {
             "type": "file",
             "id": "12345"
           },
           {
             "type": "file",
             "id": "34325"
           },
           {
             "type": "folder",
             "id": "45678"
           }
         ]
       }'
  ```

  ```typescript Node/TypeScript v10 theme={null}
  await client.zipDownloads.createZipDownload({
    items: [
      {
        id: file1.id,
        type: 'file' as ZipDownloadRequestItemsTypeField,
      } satisfies ZipDownloadRequestItemsField,
      {
        id: file2.id,
        type: 'file' as ZipDownloadRequestItemsTypeField,
      } satisfies ZipDownloadRequestItemsField,
      {
        id: folder1.id,
        type: 'folder' as ZipDownloadRequestItemsTypeField,
      } satisfies ZipDownloadRequestItemsField,
    ],
    downloadFileName: 'zip',
  } satisfies ZipDownloadRequest);
  ```

  ```python Python v10 theme={null}
  client.zip_downloads.create_zip_download(
      [
          CreateZipDownloadItems(id=file_1.id, type=DownloadZipItemsTypeField.FILE),
          CreateZipDownloadItems(id=file_2.id, type=DownloadZipItemsTypeField.FILE),
          CreateZipDownloadItems(id=folder_1.id, type=DownloadZipItemsTypeField.FOLDER),
      ],
      download_file_name="zip",
  )
  ```

  ```csharp .NET v10 theme={null}
  await client.ZipDownloads.CreateZipDownloadAsync(requestBody: new ZipDownloadRequest(items: Array.AsReadOnly(new [] {new ZipDownloadRequestItemsField(id: file1.Id, type: ZipDownloadRequestItemsTypeField.File),new ZipDownloadRequestItemsField(id: file2.Id, type: ZipDownloadRequestItemsTypeField.File),new ZipDownloadRequestItemsField(id: folder1.Id, type: ZipDownloadRequestItemsTypeField.Folder)})) { DownloadFileName = "zip" });
  ```

  ```swift Swift v10 theme={null}
  try await client.zipDownloads.createZipDownload(requestBody: ZipDownloadRequest(items: [ZipDownloadRequestItemsField(id: file1.id, type: ZipDownloadRequestItemsTypeField.file), ZipDownloadRequestItemsField(id: file2.id, type: ZipDownloadRequestItemsTypeField.file), ZipDownloadRequestItemsField(id: folder1.id, type: ZipDownloadRequestItemsTypeField.folder)], downloadFileName: "zip"))
  ```

  ```java Java v10 theme={null}
  client.getZipDownloads().createZipDownload(new ZipDownloadRequest.Builder(Arrays.asList(new ZipDownloadRequestItemsField(ZipDownloadRequestItemsTypeField.FILE, file1.getId()), new ZipDownloadRequestItemsField(ZipDownloadRequestItemsTypeField.FILE, file2.getId()), new ZipDownloadRequestItemsField(ZipDownloadRequestItemsTypeField.FOLDER, folder1.getId()))).downloadFileName("zip").build())
  ```

  ```java Java v5 theme={null}
  ArrayList<BoxZipItem> items = new ArrayList<BoxZipItem>();
  BoxZipItem file = new BoxZipItem("file", "12345");
  BoxZipItem folder = new BoxZipItem("folder", "156472");
  items.add(file);
  items.add(folder);
  BoxZip zip = new BoxZip(api);
  BoxZipInfo zipInfo = zip.create("Awesome Zip File", items);
  ```

  ```js Node v4 theme={null}
  var name = 'test',
  items = [
   {
    type: 'file',
    id: '466239504569'
   },
   {
    type: 'folder',
    id: '466239504580'
   }
  ];
  client.files.createZip(name, items)
   .then(zip => {
    /* zip -> {
      "download_url": "https://api.box.com/2.0/zip_downloads/124hfiowk3fa8kmrwh/content",
      "status_url": "https://api.box.com/2.0/zip_downloads/124hfiowk3fa8kmrwh/status",
      "expires_at": "2018-04-25T11:00:18-07:00",
      "name_conflicts": [
       [
        {
         "id": "100",
         "type": "file",
         "original_name": "salary.pdf",
         "download_name": "aqc823.pdf"
        },
        {
         "id": "200",
         "type": "file",
         "original_name": "salary.pdf",
         "download_name": "aci23s.pdf"
        }
       ],
       [
        {
         "id": "1000",
         "type": "folder",
         "original_name": "employees",
         "download_name": "3d366a_employees"
        },
        {
         "id": "2000",
         "type": "folder",
         "original_name": "employees",
         "download_name": "3aa6a7_employees"
        }
       ]
      ]
     }
    */
   });
  ```
</CodeGroup>

The response will look similar to the following:

```json theme={null}
{
  "download_url": "https://dl.boxcloud.com/2.0/zip_downloads/25gvaXcIE4QJlinNiw2oHAQ==ZFs3Q2Xpd7pKBz7OyzXNrUaoW3aJxQRN5znAvyM-KpdEEPdWcQDKU-Dl85Ew/content",
  "status_url": "https://api.box.com/2.0/zip_downloads/25gvaXcIE4QJlinNiw2oHAQ==ZFs3Q2Xpd7pKBz7OyzXNrUaoW3aJxQRN5znAvyM-KpdEEPdWcQDKU-Dl85Ew/status",
  "expires_at": "2023-02-28T10:23:54Z",
  "name_conflicts": []
}
```

## Extract the ZIP download ID

To download the ZIP archive, you need the ZIP download ID.
You can find it in the response you got when you created the archive.

Go to `status_url` and copy the ID located between`zip_downloads` and `content`:

```json theme={null}
25gvaXcIE4QJlinNiw2oHAQ==ZFs3Q2Xpd7pKBz7OyzXNrUaoW3aJxQRN5znAvyM-KpdEEPdWcQDKU-Dl85Ew
```

<Note>
  Download URL is valid only for a the time specified in `expires_at` parameter.
</Note>

## Download files

Place the download ID in the file location URL as in the sample below
to point to the right files.

<CodeGroup>
  ```sh cURL theme={null}
  curl -L GET "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content" \
       -H "authorization: Bearer <ACCESS_TOKEN>" \
       -o sample_curl.zip
  ```

  ```typescript Node/TypeScript v10 theme={null}
  await client.zipDownloads.getZipDownloadContent(zipDownload.downloadUrl!);
  ```

  ```python Python v10 theme={null}
  client.zip_downloads.get_zip_download_content(zip_download.download_url)
  ```

  ```csharp .NET v10 theme={null}
  await client.ZipDownloads.GetZipDownloadContentAsync(downloadUrl: NullableUtils.Unwrap(zipDownload.DownloadUrl));
  ```

  ```swift Swift v10 theme={null}
  try await client.zipDownloads.getZipDownloadContent(downloadUrl: zipDownload.downloadUrl!, downloadDestinationUrl: URL(path: destinationPathString))
  ```

  ```java Java v10 theme={null}
  client.getZipDownloads().getZipDownloadContent(zipDownload.getDownloadUrl())
  ```

  ```java Java v5 theme={null}
  ArrayList<BoxZipItem> items = new ArrayList<BoxZipItem>();
  BoxZipItem file = new BoxZipItem("file", "12345");
  BoxZipItem folder = new BoxZipItem("folder", "156472");
  items.add(file);
  items.add(folder);
  BoxZip zip = new BoxZip(api);
  FileOutputStream stream = new FileOutputStream();
  BoxZipDownloadStatus zipDownloadStatus = zip.download("Another Awesome Zip File", items, stream);
  stream.close();
  if (zipDownloadStatus.getState() == BoxZipDownloadStatus.State.SUCCEEDED) {
      System.out.println("Zip downloaded successfully");
  }
  ```

  ```py Python v4 theme={null}
  name = 'test'
  file = mock_client.file('466239504569')
  folder = mock_client.folder('466239504580')
  items = [file, folder]
  output_file = open('test.zip', 'wb')
  status = client.download_zip(name, items, output_file)
  print(f'The status of the zip download is {status["state"]}')
  ```

  ```csharp .NET v6 theme={null}
  BoxZipRequest request = new BoxZipRequest();
  request.Name = "test";
  request.Items = new List<BoxZipItemRequest>();

  var file = new BoxZipRequestItem()
  {
      Id = "466239504569",
      Type = BoxZipItemType.file
  };
  var folder = new BoxZipRequestItem()
  {
      Id = "466239504580",
      Type = BoxZipItemType.folder
  };
  request.Items.Add(file);
  request.Items.Add(folder);
  Stream fs = new FileStream(@"c:\temp\MyTest.zip");

  BoxZipDownloadStatus status = await _filesManager.DownloadZip(request, fs);
  ```

  ```js Node v4 theme={null}
  var name = 'test',
  items = [
   {
    type: 'file',
    id: '466239504569'
   },
   {
    type: 'folder',
    id: '466239504580'
   }
  ],
  stream = new Readable();
  client.files.downloadZip(name, items, stream)
   .then(status => {
    /* status -> {
      "total_file_count": 20,
      "downloaded_file_count": 10,
      "skipped_file_count": 10,
      "skipped_folder_count": 10,
      "state": "succeeded"
     }
    */
   });
  ```
</CodeGroup>

For downloads that take longer, you can monitor the
download status using the
<Link href="/reference/get-zip-downloads-id-status">status endpoint</Link>.
This allows you to inspect the progress of the
download as well as the number of items that might have been skipped.

<CodeGroup>
  ```sh cURL theme={null}
  curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status" \
       -H "authorization: Bearer <ACCESS_TOKEN>"
  ```

  ```typescript Node/TypeScript v10 theme={null}
  await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);
  ```

  ```python Python v10 theme={null}
  client.zip_downloads.get_zip_download_status(zip_download.status_url)
  ```

  ```csharp .NET v10 theme={null}
  await client.ZipDownloads.GetZipDownloadStatusAsync(statusUrl: NullableUtils.Unwrap(zipDownload.StatusUrl));
  ```

  ```swift Swift v10 theme={null}
  try await client.zipDownloads.getZipDownloadStatus(statusUrl: zipDownload.statusUrl!)
  ```

  ```java Java v10 theme={null}
  client.getZipDownloads().getZipDownloadStatus(zipDownload.getStatusUrl())
  ```
</CodeGroup>

<Note>
  If you want to use SDKs to download the contents
  of the folder, follow <Link href="/guides/downloads/folder">this</Link> guide.
</Note>

<RelatedLinks
  title="RELATED APIS"
  items={[
{ label: translate("Download zip archive"), href: "/reference/get-zip-downloads-id-content", badge: "GET" },
{ label: translate("Get zip download status"), href: "/reference/get-zip-downloads-id-status", badge: "GET" },
{ label: translate("Create zip download"), href: "/reference/post-zip-downloads", badge: "POST" }
]}
/>