---
title: "Check a zip download"
method: GET
path: "/downloads/{id}"
tags: ["Downloads"]
---

# Check a zip download

`GET /downloads/{id}`

## Request

- Base URL: `https://api.propertypixel.app/v1`
- URL: `https://api.propertypixel.app/v1/downloads/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://llflgtovnkrsjqydycyu.supabase.co/auth/v1/oauth/authorize`, token URL `https://llflgtovnkrsjqydycyu.supabase.co/auth/v1/oauth/token`)

Check a zip started by get_download_link. While status is processing, wait poll_after_ms and call again; when ready, url is the zip (valid for 1 hour). If it failed, call get_download_link again.

Works with view-only access.

## Path parameters

- `id` string, required: Download ID from get_download_link.

## Response `200`

Check a zip download

- Download
  - `object` 'download', required
  - `id` string, nullable, required: Zip download ID to poll with get_download while status is processing. Null when the links are ready immediately.
  - `status` 'processing' | 'ready' | 'failed', required
  - `url` string, uri, nullable, required: The file to download: the single version, or the zip once ready. Null while processing, and when files lists per-file links instead.
  - `filename` string, nullable, required
  - `expires_at` string, date-time, nullable, required: When url stops working.
  - `files` object[], required: One signed link per file. Used instead of a zip whenever videos are included (videos are too large to zip server-side).
    - `job_id` string, uuid, required
    - `kind` 'photo' | 'video', required
    - `filename` string, required
    - `url` string, uri, required
    - `expires_at` string, date-time, required
  - `file_count` integer, nullable, required
  - `unavailable_job_ids` string[], required: Requested versions left out because they were deleted, unfinished or failed to package.
  - `poll_after_ms` integer, required: 0 unless status is processing.

## Other responses

- `400`: The request is invalid. Codes: `validation_failed`.
- `401`: Missing, invalid or revoked credential. Codes: `unauthorized`.
- `403`: The credential can't do this. View-only connections get forbidden_scope on writes. Codes: `forbidden_scope`, `forbidden`.
- `404`: The resource doesn't exist in this workspace. Codes: `not_found`.
- `429`: Too many requests for this connection. Codes: `rate_limited`.
- `500`: Something failed on our side. Retry later. Codes: `internal`.

---

[API](https://skmtc.dev/propertypixel/apis/propertypixel-api.md) · [All operations](https://skmtc.dev/propertypixel/apis/propertypixel-api/llms.txt) · [OpenAPI document](https://skmtc.dev/propertypixel/apis/propertypixel-api/revisions/8f7baef701cc?raw)