Projects

Get a project

Get one project with all its photos (IDs, room types, signed preview URLs) and the status of its most recent upload link (waiting, receiving, done or expired). Use the photo IDs with enhance_photos, stage_photos or create_video. To see finished edits, call show_results instead.

Works with view-only access.

get/projects/{id}

Request

  • Base URL: https://api.propertypixel.app/v1
  • URL: https://api.propertypixel.app/v1/projects/{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)

Path parameters

idstring uuid required

Project ID.

Response

Get a project

object'project' required
idstring uuid required
namestring required
addressstring nullable required
property_typestring nullable required
photo_countinteger required
completed_job_countinteger required
studio_urlstring uri required

Open this project in the PropertyPixel Studio.

created_atstring date-time required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.