PropertyPixel Docs

Get account

GET
/account

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.

Authorization

headerAuthorizationBearer <token>

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

Response Body

Get account

application/json
  1. response
object*string
email*string|null
workspace*
scope*

Access level of this connection.

credits*

100 credits = one standard photo enhancement.

plan*
manage_credits_url*|

Where to add credits or change plan. Null inside ChatGPT.

studio_url*string

The PropertyPixel Studio, to open projects on the web.

Formaturi
curl -X GET "https://example.com/account"
{  "object": "account",  "email": "string",  "workspace": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "kind": "personal",    "role": "owner"  },  "scope": {    "effective": "read",    "granted": "read"  },  "credits": {    "available": 0,    "subscription": 0,    "topup": 0,    "trial": 0  },  "plan": {    "tier": "string",    "status": "string",    "is_trial": true,    "watermarked": true  },  "manage_credits_url": "string",  "studio_url": "http://example.com"}