PropertyPixel Docs
API referenceProjects

List projects

GET
/projects

List the property projects in the connected workspace, newest first by default. Each project groups the photos of one listing. Use search to find a project by name or address before asking the user for an ID. Returns project IDs, photo counts, a cover image and a Studio link; page with next_cursor.

Works with view-only access.

Authorization

headerAuthorizationBearer <token>

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

Query Parameters

search?string

Case-insensitive match on project name or address.

Lengthlength <= 200
sort?string

Sort order.

Default"newest"
Value in"newest""oldest""name_asc""name_desc"
cursor?string

Opaque cursor from a previous page's next_cursor.

limit?integer

Page size (1–100).

Range1 <= value <= 100
Default25

Response Body

List projects

application/json
  1. response
data*array<>
next_cursor*string|null
curl -X GET "https://example.com/projects"
{  "data": [    {      "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"    }  ],  "next_cursor": "string"}

Get account GET

Get the connected PropertyPixel account: the workspace and the user's role in it, whether this connection can make changes, the credit balance (100 credits = one photo enhancement), the plan, and whether results are watermarked (trial). Call this before spending to check the balance, or when the user asks about their credits or plan. Works with view-only access.

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.