---
title: "Check job status"
method: GET
path: "/jobs"
tags: ["Jobs"]
---

# Check job status

`GET /jobs`

## Request

- Base URL: `https://api.propertypixel.app/v1`
- URL: `https://api.propertypixel.app/v1/jobs`
- 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 progress of up to 100 jobs returned by enhance_photos, stage_photos, apply_recommendations or create_video. Returns status (pending, processing, completed, failed, cancelled), progress, result URLs (signed for 1 hour) and a poll_after_ms hint. Photo edits usually finish in under a minute and videos in a few minutes; wait poll_after_ms between checks instead of calling in a tight loop. Failed jobs are refunded automatically.

Works with view-only access.

## Query parameters

- `ids` string[], required: Job IDs, as an array or comma-separated (max 100).

## Response `200`

Check job status

- JobStatusList
  - `object` 'job_status', required
  - `jobs` Job[], required: The requested jobs in request order. IDs you can't access are left out.
    - `object` 'job', required
    - `id` string, uuid, required
    - `kind` 'enhancement' | 'staging' | 'video', required
    - `status` 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled', required
    - `progress` number, nullable, required: Percent complete while processing.
    - `stage` string, nullable, required
    - `project_id` string, uuid, nullable, required
    - `photo_id` string, uuid, nullable, required: Source photo (null for multi-photo videos).
    - `photo_ids` string[], required: All source photos, in order (videos can have up to 9).
    - `source_job_id` string, uuid, nullable, required: Prior version this edit was applied on top of.
    - `enhancement_types` string[], required
    - `design_style` string, nullable, required
    - `ultra_hd` boolean, required
    - `credits` integer, nullable, required
    - `picked` boolean, required
    - `watermarked` boolean, required
    - `result` MediaUrl, required
      - `url` string, uri, required
      - `expires_at` string, date-time, required: Signed URL expiry (about 1 hour). Re-fetch for a fresh URL.
    - `thumbnail` MediaUrl, required
      - `url` string, uri, required
      - `expires_at` string, date-time, required: Signed URL expiry (about 1 hour). Re-fetch for a fresh URL.
    - `error` object, nullable, required: Why the job failed. Failed jobs are refunded automatically.
      - `code` string, required
      - `message` string, required
    - `created_at` string, date-time, required
    - `completed_at` string, date-time, nullable, required
  - `all_done` boolean, required: True when every job is completed, failed or cancelled.
  - `poll_after_ms` integer, required: Wait this long before polling again. 0 means nothing is left to wait for.

## 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)