---
title: "Get zip download status"
method: GET
path: "/zip_downloads/{zip_download_id}/status"
tags: ["Zip Downloads"]
---

# Get zip download status

`GET /zip_downloads/{zip_download_id}/status`

Returns the download status of a `zip` archive, allowing an application to
inspect the progress of the download as well as the number of items that
might have been skipped.

This endpoint can only be accessed once the download has started.
Subsequently this endpoint is valid for 12 hours from the start of the
download.

The URL of this endpoint should not be considered as fixed. Instead, use
the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a
`zip` archive, and then follow the `status_url` field in the response to
this endpoint.

## Path parameters

- `zip_download_id` string, required

## Response `200`

Returns the status of the `zip` archive that is being downloaded.

- ZipDownloadStatus — The status of a `zip` archive being downloaded.
  - `total_file_count` integer — The total number of files in the archive.
  - `downloaded_file_count` integer — The number of files that have already been downloaded.
  - `skipped_file_count` integer — The number of files that have been skipped as they could not be downloaded. In many cases this is due to permission issues that have surfaced between the creation of the request for the archive and the archive being downloaded.
  - `skipped_folder_count` integer — The number of folders that have been skipped as they could not be downloaded. In many cases this is due to permission issues that have surfaced between the creation of the request for the archive and the archive being downloaded.
  - `state` 'in_progress' | 'failed' | 'succeeded' — The state of the archive being downloaded.

## Other responses

- `401` — Returned when the access token provided in the `Authorization` header is not recognized or not provided.
- `403` — Returned when an authorization header is provided but the user does not have access to the items.
- `404` — Returns an error if the ID of this download request is not valid, or if the status of a download is requested before the download has been started.
- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/versions/ba8f087e1a4d/schema)