---
title: "Get account"
method: GET
path: "/account"
tags: ["Account"]
---

# Get account

`GET /account`

## Request

- Base URL: `https://api.propertypixel.app/v1`
- URL: `https://api.propertypixel.app/v1/account`
- 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`)

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.

## Response `200`

Get account

- Account
  - `object` 'account', required
  - `email` string, nullable, required
  - `workspace` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `kind` 'personal' | 'team', required
    - `role` 'owner' | 'editor' | 'reviewer', required
  - `scope` object, required: Access level of this connection.
    - `effective` 'read' | 'write', required: What this connection can do now: `write` can create, delete and spend credits; `read` can only view, pick and download.
    - `granted` 'read' | 'write', required: What was granted when connecting. Effective is lower only if the user's workspace role was reduced since.
  - `credits` object, required: 100 credits = one standard photo enhancement.
    - `available` integer, required: Total credits that can be spent now.
    - `subscription` integer, required
    - `topup` integer, required
    - `trial` integer, required
  - `plan` object, required
    - `tier` string, required: Plan name, e.g. starter, professional, studio or trial.
    - `status` string, required: trial, active, past_due, cancelled or expired.
    - `is_trial` boolean, required
    - `watermarked` boolean, required: True when results carry the PropertyPixel watermark.
  - `manage_credits_url` string, nullable, required: Where to add credits or change plan. Null inside ChatGPT.
  - `studio_url` string, uri, required: The PropertyPixel Studio, to open projects on the web.

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