Get zip download 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 API to request to create a zip archive, and then follow the status_url field in the response to this endpoint.



Path Parameters

stringin pathrequired

The unique identifier that represent this zip archive.


application/jsonZip download status

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

application/jsonClient error

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

application/jsonClient error

Returned when an authorization header is provided but the user does not have access to the items.

application/jsonClient error

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.

application/jsonClient error

An unexpected client error.

Get zip download status
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

curl -i -X GET "" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);
Python Gen
.NET Gen (Beta)
await client.ZipDownloads.GetZipDownloadStatusAsync(statusUrl: NullableUtils.Unwrap(zipDownload.StatusUrl));

Response Example

  "downloaded_file_count": 10,
  "skipped_file_count": 5,
  "skipped_folder_count": 5,
  "state": "succeeded",
  "total_file_count": 20