PropertyPixel Docs
API referenceProjects

Get a project

GET
/projects/{id}

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.

Authorization

headerAuthorizationBearer <token>

An API key from Settings → Developers (pp_live_…), or an OAuth access token.

Path Parameters

id*string

Project ID.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

Get a project

application/json
  1. response
object*string
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
address*string|null
property_type*string|null
photo_count*integer
completed_job_count*integer
cover*|null
studio_url*string

Open this project in the PropertyPixel Studio.

Formaturi
created_at*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
updated_at*|null
photos*array<>
upload_link*|

The most recent upload link for this project, if any. The URL is only returned when the link is created.

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "object": "project",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "address": "string",  "property_type": "string",  "photo_count": 0,  "completed_job_count": 0,  "cover": {    "url": "http://example.com",    "expires_at": "2019-08-24T14:15:22Z"  },  "studio_url": "http://example.com",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "photos": [    {      "object": "photo",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",      "filename": "string",      "room_type": "string",      "width": 0,      "height": 0,      "original": {        "url": "http://example.com",        "expires_at": "2019-08-24T14:15:22Z"      },      "thumbnail": {        "url": "http://example.com",        "expires_at": "2019-08-24T14:15:22Z"      },      "created_at": "2019-08-24T14:15:22Z"    }  ],  "upload_link": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "status": "waiting",    "photos_received": 0,    "expires_at": "2019-08-24T14:15:22Z"  }}

Create a project POST

Create a new, empty project for one property listing. Name it after the address or listing so the user can find it later. Then add photos with add_photos or create_upload_link. Requires a connection with edit access.

Delete a project DELETE

Delete a project with all its photos and edited results. Only do this when the user explicitly asks to delete that project; confirm the project name with them first. It disappears from the Studio immediately. Requires a connection with edit access.