Properties

Resale and rental listings: fields, statuses, price history, key register, map search and saved views.

GET/v1/properties

List listings

Keyset-paginated listings within the caller’s view scope. `filter` takes the shared filter DSL over PROPERTY_FILTER_FIELDS, `q` searches the title, society and P- reference; `near_*`/`radius_m` or `polygon` narrow by map area (PostGIS). Sort keys: created_at, updated_at, price, rent_amount, area_sqft (- for descending).

Access: API key with properties:read, or a member session. Permission properties.view.

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
sortquery: string
Comma list of sort keys, "-" prefix for descending, e.g. -received_at.
filterquery: string
Filter tree ({ all | any | not | field/op/value }) as JSON or base64url(JSON).
qquery: string
Free-text search.
near_latquery: number
near_lngquery: number
radius_mquery: integer
polygonquery: string
JSON array of [lng, lat] pairs (3–200 points), or base64url of it.

Response · 200

datarequired: array of PropertySummary
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/properties' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "P-2031",
      "listing_type": "sale",
      "category": "residential",
      "property_type": "apartment",
      "title": "string",
      "status": "draft",
      "bhk": 0,
      "bathrooms": 0,
      "layout": "simplex",
      "carpet_area": 0,
      "builtup_area": 0,
      "super_area": 0,
      "plot_area": 0,
      "area_unit": "sqft",
      "area_sqft": 0,
      "price": 850000000,
      "price_per_sqft": 850000000,
      "price_on_request": true,
      "rent_amount": 850000000,
      "deposit_amount": 850000000,
      "maintenance_amount": 850000000,
      "maintenance_period": "string",
      "furnishing": "unfurnished",
      "facing": "north",
      "possession_status": "ready_to_move",
      "possession_date": "2026-10-06",
      "available_from": "2026-10-06",
      "society_name": "string",
      "sub_locality": "string",
      "city": "string",
      "locality": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "city": "string"
      },
      "latitude": 0,
      "longitude": 0,
      "location_precision": "exact",
      "cover_url": "string",
      "photos_count": 0,
      "matches_count": 0,
      "listed_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "is_featured": true,
      "verified_at": "2026-10-06T05:30:00.000Z",
      "verification_badge": {
        "status": "verified",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "valid_until": "2026-10-06"
      },
      "views_count": 0,
      "shares_count": 0,
      "enquiries_count": 0,
      "visits_count": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties

Create a listing

Creates a draft (or an active listing when complete). The P- reference is allocated per company.

Access: API key with properties:write, or a member session. Permission properties.create.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

listing_typerequired: ListingType
category: PropertyCategory
property_typerequired: PropertyType
title: string
Generated from the facts when left out.
description: string or null
owner_contact_id: Id or null
Opaque record id.
owner: PropertyOwnerInput or null
mandate: MandateType or null
mandate_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
owner_expected_price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
brokerage_from_owner: string or null
brokerage_from_client: string or null
key_with: "owner" | "agent" | "office" | "security" | "tenant" | "other" or null
visit_instructions: string or null
project_id: Id or null
Opaque record id.
society_name: string or null
building: string or null
unit_no: string or null
floor: integer or null
total_floors: integer or null
address: string or null
locality_id: Id or null
Opaque record id.
sub_locality: string or null
landmark: string or null
city: string
Defaults to the company's city.
state: string or null
pincode: string or null
latitude: number or null
longitude: number or null
bhk: number or null
bedrooms: integer or null
bathrooms: integer or null
layout: Layout or null
balconies: integer or null
extra_rooms: array of "study" | "servant" | "pooja" | "store"
carpet_area: number or null
builtup_area: number or null
super_area: number or null
plot_area: number or null
area_unit: AreaUnit
sqyd is gaj.
plot_length: number or null
plot_breadth: number or null
road_width_ft: number or null
frontage_ft: number or null
facing: Facing or null
is_corner: boolean
overlooking: array of "park" | "main_road" | "pool" | "club" | "garden"
vastu_compliant: boolean or null
furnishing: Furnishing or null
furnishing_items: array of "ac" | "wardrobe" | "modular_kitchen" | "geyser" | "fridge" | "washing_machine" | …
possession_status: PossessionStatus or null
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
year_built: integer or null
transaction_type: TransactionType or null
ownership: Ownership or null
approvals: map of boolean or string or null
State-aware approvals, e.g. { "khata": "A", "oc": true, "authority": "BBMP" }.
rera_number: string or null
loan_banks: array of string
covered_parking: integer or null
open_parking: integer or null
two_wheeler_parking: integer or null
amenity_ids: array of Id
Opaque record id.
water_supply: "corporation" | "borewell" | "both" | "tanker" or null
power_backup: "none" | "partial" | "full" or null
gated_community: boolean or null
price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
price_negotiable: boolean
price_on_request: boolean
all_inclusive: boolean or null
maintenance_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_period: "monthly" | "quarterly" | "yearly" | "one_time" or null
token_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
rent_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_included: boolean or null
deposit_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
deposit_months: number or null
lock_in_months: integer or null
notice_months: integer or null
agreement_months: integer or null
escalation_pct: number or null
rent_floor: PaiseInput or null
The lowest monthly rent the owner accepts (paise).
deposit_floor: PaiseInput or null
The lowest deposit the owner accepts (paise).
lock_in_max_months: integer or null
The longest lock-in the owner accepts (months).
available_from: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
tenant_preferences: array of "family" | "bachelor_male" | "bachelor_female" | "company" | "students"
pets_allowed: boolean or null
non_veg_allowed: boolean or null
listed_by_id: Id or null
Opaque record id.
co_broking: boolean
network_visibility: "private" | "company" | "network" | "public"
is_featured: boolean
expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
custom: map of any
status: "draft" | "active"

Response · 201

datarequired: PropertyDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"listing_type":"sale","category":"residential","property_type":"apartment","title":"string","description":"string","owner_contact_id":"cmusrceel0000q7kaafxqi1om","owner":{"name":"string","phone":"string","email":"name@example.com"},"mandate":"exclusive","mandate_expires_on":"2026-10-06","owner_expected_price":0,"brokerage_from_owner":"string","brokerage_from_client":"string","key_with":"owner","visit_instructions":"string","project_id":"cmusrceel0000q7kaafxqi1om","society_name":"string","building":"string","unit_no":"string","floor":0,"total_floors":0,"address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","sub_locality":"string","landmark":"string","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"bhk":0,"bedrooms":0,"bathrooms":0,"layout":"simplex","balconies":0,"extra_rooms":["study"],"carpet_area":0,"builtup_area":0,"super_area":0,"plot_area":0,"area_unit":"sqft","plot_length":0,"plot_breadth":0,"road_width_ft":0,"frontage_ft":0,"facing":"north","is_corner":true,"overlooking":["park"],"vastu_compliant":true,"furnishing":"unfurnished","furnishing_items":["ac"],"possession_status":"ready_to_move","possession_date":"2026-10-06","year_built":1800,"transaction_type":"new_booking","ownership":"freehold","approvals":{},"rera_number":"string","loan_banks":["string"],"covered_parking":0,"open_parking":0,"two_wheeler_parking":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"water_supply":"corporation","power_backup":"none","gated_community":true,"price":0,"price_negotiable":true,"price_on_request":true,"all_inclusive":true,"maintenance_amount":0,"maintenance_period":"monthly","token_amount":0,"rent_amount":0,"maintenance_included":true,"deposit_amount":0,"deposit_months":0,"lock_in_months":0,"notice_months":0,"agreement_months":0,"escalation_pct":0,"rent_floor":0,"deposit_floor":0,"lock_in_max_months":0,"available_from":"2026-10-06","tenant_preferences":["family"],"pets_allowed":true,"non_veg_allowed":true,"listed_by_id":"cmusrceel0000q7kaafxqi1om","co_broking":true,"network_visibility":"private","is_featured":true,"expires_on":"2026-10-06","custom":{},"status":"draft"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "P-2031",
    "listing_type": "sale",
    "category": "residential",
    "property_type": "apartment",
    "title": "string",
    "status": "draft",
    "bhk": 0,
    "bathrooms": 0,
    "layout": "simplex",
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "plot_area": 0,
    "area_unit": "sqft",
    "area_sqft": 0,
    "price": 850000000,
    "price_per_sqft": 850000000,
    "price_on_request": true,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance_amount": 850000000,
    "maintenance_period": "string",
    "furnishing": "unfurnished",
    "facing": "north",
    "possession_status": "ready_to_move",
    "possession_date": "2026-10-06",
    "available_from": "2026-10-06",
    "society_name": "string",
    "sub_locality": "string",
    "city": "string",
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "latitude": 0,
    "longitude": 0,
    "location_precision": "exact",
    "cover_url": "string",
    "photos_count": 0,
    "matches_count": 0,
    "listed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "is_featured": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "verification_badge": {
      "status": "verified",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06"
    },
    "views_count": 0,
    "shares_count": 0,
    "enquiries_count": 0,
    "visits_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "description": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "building": "string",
    "floor": 0,
    "total_floors": 0,
    "landmark": "string",
    "state": "string",
    "pincode": "string",
    "bedrooms": 0,
    "balconies": 0,
    "extra_rooms": [
      "string"
    ],
    "plot_length": 0,
    "plot_breadth": 0,
    "road_width_ft": 0,
    "frontage_ft": 0,
    "is_corner": true,
    "overlooking": [
      "string"
    ],
    "vastu_compliant": true,
    "furnishing_items": [
      "string"
    ],
    "year_built": 0,
    "transaction_type": "new_booking",
    "ownership": "freehold",
    "approvals": {},
    "rera_number": "string",
    "loan_banks": [
      "string"
    ],
    "covered_parking": 0,
    "open_parking": 0,
    "two_wheeler_parking": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "water_supply": "string",
    "power_backup": "string",
    "gated_community": true,
    "price_negotiable": true,
    "all_inclusive": true,
    "token_amount": 850000000,
    "maintenance_included": true,
    "deposit_months": 0,
    "lock_in_months": 0,
    "notice_months": 0,
    "agreement_months": 0,
    "escalation_pct": 0,
    "tenant_preferences": [
      "string"
    ],
    "pets_allowed": true,
    "non_veg_allowed": true,
    "co_broking": true,
    "network_visibility": "string",
    "expires_on": "2026-10-06",
    "custom": {},
    "created_by_id": "string",
    "owner": {
      "contact_id": "string",
      "name": "string",
      "phone": "string",
      "key_with": "string",
      "visit_instructions": "string"
    },
    "unit_no": "string",
    "address": "string",
    "owner_expected_price": 850000000,
    "rent_floor": 850000000,
    "deposit_floor": 850000000,
    "lock_in_max_months": 0,
    "mandate": {
      "type": "string",
      "expires_on": "string",
      "brokerage_from_owner": "string",
      "brokerage_from_client": "string"
    },
    "price_history": [
      {
        "at": "2026-10-06T05:30:00.000Z",
        "field": "price",
        "from": 850000000,
        "to": 850000000,
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "allowed_statuses": [
      "draft"
    ],
    "can": {
      "edit": true,
      "delete": true,
      "share": true,
      "publish": true,
      "documents": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/amenities

Amenities

Global amenities plus the company’s own, in display order.

Access: API key with properties:read, or a member session. Permission properties.view.

Response · 200

datarequired: array of AmenityRef
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/amenities' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "category": "string",
      "icon": "string"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties/bulk/status

Move several listings to a status

Each listing is checked on its own; the response says which moved and why the others did not.

Access: API key with properties:write, or a member session. Permission properties.edit.

Request body

idsrequired: array of Id
Opaque record id.
statusrequired: ListingStatus
`active` is shown as "Available".

Response · 200

datarequired: object
data.updatedrequired: array of Id
Opaque record id.
data.skippedrequired: array of object
data.skipped[].idrequired: Id
Opaque record id.
data.skipped[].reasonrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties/bulk/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"],"status":"draft"}'

Response example

{
  "data": {
    "updated": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "skipped": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "reason": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties/from-lead

Draft a listing from an owner lead

Owner acquisition (E6-04): a sell / let-out lead becomes a draft listing with its contact as the owner and the mandate terms; the lead is linked to the listing. Running it again returns the listing already linked.

Access: API key with properties:write, or a member session. Permission properties.create.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

lead_idrequired: Id
Opaque record id.
mandate: MandateType or null
mandate_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
brokerage_from_owner: string or null

Response · 201

datarequired: PropertyDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties/from-lead' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","mandate":"exclusive","mandate_expires_on":"2026-10-06","brokerage_from_owner":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "P-2031",
    "listing_type": "sale",
    "category": "residential",
    "property_type": "apartment",
    "title": "string",
    "status": "draft",
    "bhk": 0,
    "bathrooms": 0,
    "layout": "simplex",
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "plot_area": 0,
    "area_unit": "sqft",
    "area_sqft": 0,
    "price": 850000000,
    "price_per_sqft": 850000000,
    "price_on_request": true,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance_amount": 850000000,
    "maintenance_period": "string",
    "furnishing": "unfurnished",
    "facing": "north",
    "possession_status": "ready_to_move",
    "possession_date": "2026-10-06",
    "available_from": "2026-10-06",
    "society_name": "string",
    "sub_locality": "string",
    "city": "string",
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "latitude": 0,
    "longitude": 0,
    "location_precision": "exact",
    "cover_url": "string",
    "photos_count": 0,
    "matches_count": 0,
    "listed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "is_featured": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "verification_badge": {
      "status": "verified",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06"
    },
    "views_count": 0,
    "shares_count": 0,
    "enquiries_count": 0,
    "visits_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "description": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "building": "string",
    "floor": 0,
    "total_floors": 0,
    "landmark": "string",
    "state": "string",
    "pincode": "string",
    "bedrooms": 0,
    "balconies": 0,
    "extra_rooms": [
      "string"
    ],
    "plot_length": 0,
    "plot_breadth": 0,
    "road_width_ft": 0,
    "frontage_ft": 0,
    "is_corner": true,
    "overlooking": [
      "string"
    ],
    "vastu_compliant": true,
    "furnishing_items": [
      "string"
    ],
    "year_built": 0,
    "transaction_type": "new_booking",
    "ownership": "freehold",
    "approvals": {},
    "rera_number": "string",
    "loan_banks": [
      "string"
    ],
    "covered_parking": 0,
    "open_parking": 0,
    "two_wheeler_parking": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "water_supply": "string",
    "power_backup": "string",
    "gated_community": true,
    "price_negotiable": true,
    "all_inclusive": true,
    "token_amount": 850000000,
    "maintenance_included": true,
    "deposit_months": 0,
    "lock_in_months": 0,
    "notice_months": 0,
    "agreement_months": 0,
    "escalation_pct": 0,
    "tenant_preferences": [
      "string"
    ],
    "pets_allowed": true,
    "non_veg_allowed": true,
    "co_broking": true,
    "network_visibility": "string",
    "expires_on": "2026-10-06",
    "custom": {},
    "created_by_id": "string",
    "owner": {
      "contact_id": "string",
      "name": "string",
      "phone": "string",
      "key_with": "string",
      "visit_instructions": "string"
    },
    "unit_no": "string",
    "address": "string",
    "owner_expected_price": 850000000,
    "rent_floor": 850000000,
    "deposit_floor": 850000000,
    "lock_in_max_months": 0,
    "mandate": {
      "type": "string",
      "expires_on": "string",
      "brokerage_from_owner": "string",
      "brokerage_from_client": "string"
    },
    "price_history": [
      {
        "at": "2026-10-06T05:30:00.000Z",
        "field": "price",
        "from": 850000000,
        "to": 850000000,
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "allowed_statuses": [
      "draft"
    ],
    "can": {
      "edit": true,
      "delete": true,
      "share": true,
      "publish": true,
      "documents": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/localities

Search localities

The locality master (global + the company’s own), matched on name and aliases ("HSR", "Bengaluru").

Access: API key with properties:read, or a member session. Permission properties.view.

Parameters

qquery: string
cityquery: string
idsquery: string
Comma-separated ids to resolve (filters and saved views).
limitquery: integer

Response · 200

datarequired: array of LocalityOption
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/localities' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string",
      "state": "string",
      "pincode": "string",
      "latitude": 0,
      "longitude": 0
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/map

Map points of listings

Pinned listings matching the same filters as the list (up to 2,000 points; approximate pins ~100 m).

Access: API key with properties:read, or a member session. Permission properties.view.

Parameters

filterquery: string
Filter tree ({ all | any | not | field/op/value }) as JSON or base64url(JSON).
qquery: string
Free-text search.
near_latquery: number
near_lngquery: number
radius_mquery: integer
polygonquery: string
JSON array of [lng, lat] pairs (3–200 points), or base64url of it.

Response · 200

datarequired: array of PropertyMapPoint
metarequired: object
meta.truncatedrequired: boolean

Request

curl -X GET 'https://api.propzolo.com/v1/properties/map' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string",
      "listing_type": "sale",
      "status": "draft",
      "bhk": 0,
      "price": 850000000,
      "rent_amount": 850000000,
      "latitude": 0,
      "longitude": 0
    }
  ],
  "meta": {
    "truncated": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/views

Saved views of the listings page

Access: Signed-in members only (web or Android session) — not for API keys. Permission properties.view.

Response · 200

datarequired: array of PropertySavedView
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/views' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "visibility": "private",
      "filters": null,
      "sort": "string",
      "layout": "table",
      "is_pinned": true,
      "mine": true
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties/views

Save a view

Team views are visible to every member who can see listings.

Access: Signed-in members only (web or Android session) — not for API keys. Permission properties.view.

Request body

namerequired: string
visibility: "private" | "team"
filtersrequired: any
Filter tree (the shared filter DSL), or null.
sort: string or null
layout: "table" | "grid" | "map"
is_pinned: boolean

Response · 201

datarequired: PropertySavedView
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties/views' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","visibility":"private","filters":null,"sort":"string","layout":"table","is_pinned":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "visibility": "private",
    "filters": null,
    "sort": "string",
    "layout": "table",
    "is_pinned": true,
    "mine": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/properties/views/{viewId}

Update a saved view

Only its author changes a view.

Access: Signed-in members only (web or Android session) — not for API keys. Permission properties.view.

Parameters

viewIdpathrequired: Id
Opaque record id.

Request body

name: string
visibility: "private" | "team"
filters: any
Filter tree (the shared filter DSL), or null.
sort: string or null
layout: "table" | "grid" | "map"
is_pinned: boolean

Response · 200

datarequired: PropertySavedView
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/properties/views/{viewId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","visibility":"private","filters":null,"sort":"string","layout":"table","is_pinned":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "visibility": "private",
    "filters": null,
    "sort": "string",
    "layout": "table",
    "is_pinned": true,
    "mine": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/properties/views/{viewId}

Delete a saved view

Access: Signed-in members only (web or Android session) — not for API keys. Permission properties.view.

Parameters

viewIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/properties/views/{viewId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/{id}

A listing

Access: API key with properties:read, or a member session. Permission properties.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PropertyDetail
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "P-2031",
    "listing_type": "sale",
    "category": "residential",
    "property_type": "apartment",
    "title": "string",
    "status": "draft",
    "bhk": 0,
    "bathrooms": 0,
    "layout": "simplex",
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "plot_area": 0,
    "area_unit": "sqft",
    "area_sqft": 0,
    "price": 850000000,
    "price_per_sqft": 850000000,
    "price_on_request": true,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance_amount": 850000000,
    "maintenance_period": "string",
    "furnishing": "unfurnished",
    "facing": "north",
    "possession_status": "ready_to_move",
    "possession_date": "2026-10-06",
    "available_from": "2026-10-06",
    "society_name": "string",
    "sub_locality": "string",
    "city": "string",
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "latitude": 0,
    "longitude": 0,
    "location_precision": "exact",
    "cover_url": "string",
    "photos_count": 0,
    "matches_count": 0,
    "listed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "is_featured": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "verification_badge": {
      "status": "verified",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06"
    },
    "views_count": 0,
    "shares_count": 0,
    "enquiries_count": 0,
    "visits_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "description": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "building": "string",
    "floor": 0,
    "total_floors": 0,
    "landmark": "string",
    "state": "string",
    "pincode": "string",
    "bedrooms": 0,
    "balconies": 0,
    "extra_rooms": [
      "string"
    ],
    "plot_length": 0,
    "plot_breadth": 0,
    "road_width_ft": 0,
    "frontage_ft": 0,
    "is_corner": true,
    "overlooking": [
      "string"
    ],
    "vastu_compliant": true,
    "furnishing_items": [
      "string"
    ],
    "year_built": 0,
    "transaction_type": "new_booking",
    "ownership": "freehold",
    "approvals": {},
    "rera_number": "string",
    "loan_banks": [
      "string"
    ],
    "covered_parking": 0,
    "open_parking": 0,
    "two_wheeler_parking": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "water_supply": "string",
    "power_backup": "string",
    "gated_community": true,
    "price_negotiable": true,
    "all_inclusive": true,
    "token_amount": 850000000,
    "maintenance_included": true,
    "deposit_months": 0,
    "lock_in_months": 0,
    "notice_months": 0,
    "agreement_months": 0,
    "escalation_pct": 0,
    "tenant_preferences": [
      "string"
    ],
    "pets_allowed": true,
    "non_veg_allowed": true,
    "co_broking": true,
    "network_visibility": "string",
    "expires_on": "2026-10-06",
    "custom": {},
    "created_by_id": "string",
    "owner": {
      "contact_id": "string",
      "name": "string",
      "phone": "string",
      "key_with": "string",
      "visit_instructions": "string"
    },
    "unit_no": "string",
    "address": "string",
    "owner_expected_price": 850000000,
    "rent_floor": 850000000,
    "deposit_floor": 850000000,
    "lock_in_max_months": 0,
    "mandate": {
      "type": "string",
      "expires_on": "string",
      "brokerage_from_owner": "string",
      "brokerage_from_client": "string"
    },
    "price_history": [
      {
        "at": "2026-10-06T05:30:00.000Z",
        "field": "price",
        "from": 850000000,
        "to": 850000000,
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "allowed_statuses": [
      "draft"
    ],
    "can": {
      "edit": true,
      "delete": true,
      "share": true,
      "publish": true,
      "documents": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/properties/{id}

Update a listing

Price and rent changes are recorded (price history, property.price_changed).

Access: API key with properties:write, or a member session. Permission properties.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

listing_type: ListingType
category: PropertyCategory
property_type: PropertyType
title: string
description: string or null
owner_contact_id: Id or null
Opaque record id.
owner: PropertyOwnerInput or null
mandate: MandateType or null
mandate_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
owner_expected_price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
brokerage_from_owner: string or null
brokerage_from_client: string or null
key_with: "owner" | "agent" | "office" | "security" | "tenant" | "other" or null
visit_instructions: string or null
project_id: Id or null
Opaque record id.
society_name: string or null
building: string or null
unit_no: string or null
floor: integer or null
total_floors: integer or null
address: string or null
locality_id: Id or null
Opaque record id.
sub_locality: string or null
landmark: string or null
city: string
state: string or null
pincode: string or null
latitude: number or null
longitude: number or null
bhk: number or null
bedrooms: integer or null
bathrooms: integer or null
layout: Layout or null
balconies: integer or null
extra_rooms: array of "study" | "servant" | "pooja" | "store"
carpet_area: number or null
builtup_area: number or null
super_area: number or null
plot_area: number or null
area_unit: AreaUnit
sqyd is gaj.
plot_length: number or null
plot_breadth: number or null
road_width_ft: number or null
frontage_ft: number or null
facing: Facing or null
is_corner: boolean
overlooking: array of "park" | "main_road" | "pool" | "club" | "garden"
vastu_compliant: boolean or null
furnishing: Furnishing or null
furnishing_items: array of "ac" | "wardrobe" | "modular_kitchen" | "geyser" | "fridge" | "washing_machine" | …
possession_status: PossessionStatus or null
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
year_built: integer or null
transaction_type: TransactionType or null
ownership: Ownership or null
approvals: map of boolean or string or null
State-aware approvals, e.g. { "khata": "A", "oc": true, "authority": "BBMP" }.
rera_number: string or null
loan_banks: array of string
covered_parking: integer or null
open_parking: integer or null
two_wheeler_parking: integer or null
amenity_ids: array of Id
Opaque record id.
water_supply: "corporation" | "borewell" | "both" | "tanker" or null
power_backup: "none" | "partial" | "full" or null
gated_community: boolean or null
price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
price_negotiable: boolean
price_on_request: boolean
all_inclusive: boolean or null
maintenance_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_period: "monthly" | "quarterly" | "yearly" | "one_time" or null
token_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
rent_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_included: boolean or null
deposit_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
deposit_months: number or null
lock_in_months: integer or null
notice_months: integer or null
agreement_months: integer or null
escalation_pct: number or null
rent_floor: PaiseInput or null
The lowest monthly rent the owner accepts (paise).
deposit_floor: PaiseInput or null
The lowest deposit the owner accepts (paise).
lock_in_max_months: integer or null
The longest lock-in the owner accepts (months).
available_from: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
tenant_preferences: array of "family" | "bachelor_male" | "bachelor_female" | "company" | "students"
pets_allowed: boolean or null
non_veg_allowed: boolean or null
listed_by_id: Id or null
Opaque record id.
co_broking: boolean
network_visibility: "private" | "company" | "network" | "public"
is_featured: boolean
expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
custom: map of any

Response · 200

datarequired: PropertyDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/properties/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"listing_type":"sale","category":"residential","property_type":"apartment","title":"string","description":"string","owner_contact_id":"cmusrceel0000q7kaafxqi1om","owner":{"name":"string","phone":"string","email":"name@example.com"},"mandate":"exclusive","mandate_expires_on":"2026-10-06","owner_expected_price":0,"brokerage_from_owner":"string","brokerage_from_client":"string","key_with":"owner","visit_instructions":"string","project_id":"cmusrceel0000q7kaafxqi1om","society_name":"string","building":"string","unit_no":"string","floor":0,"total_floors":0,"address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","sub_locality":"string","landmark":"string","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"bhk":0,"bedrooms":0,"bathrooms":0,"layout":"simplex","balconies":0,"extra_rooms":["study"],"carpet_area":0,"builtup_area":0,"super_area":0,"plot_area":0,"area_unit":"sqft","plot_length":0,"plot_breadth":0,"road_width_ft":0,"frontage_ft":0,"facing":"north","is_corner":true,"overlooking":["park"],"vastu_compliant":true,"furnishing":"unfurnished","furnishing_items":["ac"],"possession_status":"ready_to_move","possession_date":"2026-10-06","year_built":1800,"transaction_type":"new_booking","ownership":"freehold","approvals":{},"rera_number":"string","loan_banks":["string"],"covered_parking":0,"open_parking":0,"two_wheeler_parking":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"water_supply":"corporation","power_backup":"none","gated_community":true,"price":0,"price_negotiable":true,"price_on_request":true,"all_inclusive":true,"maintenance_amount":0,"maintenance_period":"monthly","token_amount":0,"rent_amount":0,"maintenance_included":true,"deposit_amount":0,"deposit_months":0,"lock_in_months":0,"notice_months":0,"agreement_months":0,"escalation_pct":0,"rent_floor":0,"deposit_floor":0,"lock_in_max_months":0,"available_from":"2026-10-06","tenant_preferences":["family"],"pets_allowed":true,"non_veg_allowed":true,"listed_by_id":"cmusrceel0000q7kaafxqi1om","co_broking":true,"network_visibility":"private","is_featured":true,"expires_on":"2026-10-06","custom":{}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "P-2031",
    "listing_type": "sale",
    "category": "residential",
    "property_type": "apartment",
    "title": "string",
    "status": "draft",
    "bhk": 0,
    "bathrooms": 0,
    "layout": "simplex",
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "plot_area": 0,
    "area_unit": "sqft",
    "area_sqft": 0,
    "price": 850000000,
    "price_per_sqft": 850000000,
    "price_on_request": true,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance_amount": 850000000,
    "maintenance_period": "string",
    "furnishing": "unfurnished",
    "facing": "north",
    "possession_status": "ready_to_move",
    "possession_date": "2026-10-06",
    "available_from": "2026-10-06",
    "society_name": "string",
    "sub_locality": "string",
    "city": "string",
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "latitude": 0,
    "longitude": 0,
    "location_precision": "exact",
    "cover_url": "string",
    "photos_count": 0,
    "matches_count": 0,
    "listed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "is_featured": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "verification_badge": {
      "status": "verified",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06"
    },
    "views_count": 0,
    "shares_count": 0,
    "enquiries_count": 0,
    "visits_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "description": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "building": "string",
    "floor": 0,
    "total_floors": 0,
    "landmark": "string",
    "state": "string",
    "pincode": "string",
    "bedrooms": 0,
    "balconies": 0,
    "extra_rooms": [
      "string"
    ],
    "plot_length": 0,
    "plot_breadth": 0,
    "road_width_ft": 0,
    "frontage_ft": 0,
    "is_corner": true,
    "overlooking": [
      "string"
    ],
    "vastu_compliant": true,
    "furnishing_items": [
      "string"
    ],
    "year_built": 0,
    "transaction_type": "new_booking",
    "ownership": "freehold",
    "approvals": {},
    "rera_number": "string",
    "loan_banks": [
      "string"
    ],
    "covered_parking": 0,
    "open_parking": 0,
    "two_wheeler_parking": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "water_supply": "string",
    "power_backup": "string",
    "gated_community": true,
    "price_negotiable": true,
    "all_inclusive": true,
    "token_amount": 850000000,
    "maintenance_included": true,
    "deposit_months": 0,
    "lock_in_months": 0,
    "notice_months": 0,
    "agreement_months": 0,
    "escalation_pct": 0,
    "tenant_preferences": [
      "string"
    ],
    "pets_allowed": true,
    "non_veg_allowed": true,
    "co_broking": true,
    "network_visibility": "string",
    "expires_on": "2026-10-06",
    "custom": {},
    "created_by_id": "string",
    "owner": {
      "contact_id": "string",
      "name": "string",
      "phone": "string",
      "key_with": "string",
      "visit_instructions": "string"
    },
    "unit_no": "string",
    "address": "string",
    "owner_expected_price": 850000000,
    "rent_floor": 850000000,
    "deposit_floor": 850000000,
    "lock_in_max_months": 0,
    "mandate": {
      "type": "string",
      "expires_on": "string",
      "brokerage_from_owner": "string",
      "brokerage_from_client": "string"
    },
    "price_history": [
      {
        "at": "2026-10-06T05:30:00.000Z",
        "field": "price",
        "from": 850000000,
        "to": 850000000,
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "allowed_statuses": [
      "draft"
    ],
    "can": {
      "edit": true,
      "delete": true,
      "share": true,
      "publish": true,
      "documents": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/properties/{id}

Delete a listing

Soft delete: the listing disappears from lists, matches and share pages (recoverable by support).

Access: API key or member session. Permission properties.delete.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/properties/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/{id}/keys

Key register of a listing

Who holds the keys and every hand-over. Private like the owner details (field rule property.owner).

Access: API key with properties:read, or a member session. Permission properties.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: KeyRegister
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/{id}/keys' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "key_with": "string",
    "movements": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "action": "check_out",
        "holder": "string",
        "holder_member": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "holder_name": "string",
        "due_back_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "at": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties/{id}/keys

Record a key hand-over

Access: API key with properties:write, or a member session. Permission properties.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "check_out" | "check_in"
holderrequired: "owner" | "agent" | "office" | "security" | "tenant" | "other"
Who holds the keys after this movement.
holder_member_id: Id or null
Opaque record id.
holder_name: string or null
due_back_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
note: string or null

Response · 201

datarequired: KeyRegister
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties/{id}/keys' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"check_out","holder":"owner","holder_member_id":"cmusrceel0000q7kaafxqi1om","holder_name":"string","due_back_at":"2026-10-06T05:30:00.000Z","note":"string"}'

Response example

{
  "data": {
    "key_with": "string",
    "movements": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "action": "check_out",
        "holder": "string",
        "holder_member": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "holder_name": "string",
        "due_back_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "at": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties/{id}/status

Move a listing to another status

Allowed moves only (see allowed_statuses); activating needs a title, a city and a price or rent.

Access: API key with properties:write, or a member session. Permission properties.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

statusrequired: ListingStatus
`active` is shown as "Available".
note: string or null

Response · 200

datarequired: PropertyDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"draft","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "P-2031",
    "listing_type": "sale",
    "category": "residential",
    "property_type": "apartment",
    "title": "string",
    "status": "draft",
    "bhk": 0,
    "bathrooms": 0,
    "layout": "simplex",
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "plot_area": 0,
    "area_unit": "sqft",
    "area_sqft": 0,
    "price": 850000000,
    "price_per_sqft": 850000000,
    "price_on_request": true,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance_amount": 850000000,
    "maintenance_period": "string",
    "furnishing": "unfurnished",
    "facing": "north",
    "possession_status": "ready_to_move",
    "possession_date": "2026-10-06",
    "available_from": "2026-10-06",
    "society_name": "string",
    "sub_locality": "string",
    "city": "string",
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "latitude": 0,
    "longitude": 0,
    "location_precision": "exact",
    "cover_url": "string",
    "photos_count": 0,
    "matches_count": 0,
    "listed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "is_featured": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "verification_badge": {
      "status": "verified",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06"
    },
    "views_count": 0,
    "shares_count": 0,
    "enquiries_count": 0,
    "visits_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "description": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "building": "string",
    "floor": 0,
    "total_floors": 0,
    "landmark": "string",
    "state": "string",
    "pincode": "string",
    "bedrooms": 0,
    "balconies": 0,
    "extra_rooms": [
      "string"
    ],
    "plot_length": 0,
    "plot_breadth": 0,
    "road_width_ft": 0,
    "frontage_ft": 0,
    "is_corner": true,
    "overlooking": [
      "string"
    ],
    "vastu_compliant": true,
    "furnishing_items": [
      "string"
    ],
    "year_built": 0,
    "transaction_type": "new_booking",
    "ownership": "freehold",
    "approvals": {},
    "rera_number": "string",
    "loan_banks": [
      "string"
    ],
    "covered_parking": 0,
    "open_parking": 0,
    "two_wheeler_parking": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "water_supply": "string",
    "power_backup": "string",
    "gated_community": true,
    "price_negotiable": true,
    "all_inclusive": true,
    "token_amount": 850000000,
    "maintenance_included": true,
    "deposit_months": 0,
    "lock_in_months": 0,
    "notice_months": 0,
    "agreement_months": 0,
    "escalation_pct": 0,
    "tenant_preferences": [
      "string"
    ],
    "pets_allowed": true,
    "non_veg_allowed": true,
    "co_broking": true,
    "network_visibility": "string",
    "expires_on": "2026-10-06",
    "custom": {},
    "created_by_id": "string",
    "owner": {
      "contact_id": "string",
      "name": "string",
      "phone": "string",
      "key_with": "string",
      "visit_instructions": "string"
    },
    "unit_no": "string",
    "address": "string",
    "owner_expected_price": 850000000,
    "rent_floor": 850000000,
    "deposit_floor": 850000000,
    "lock_in_max_months": 0,
    "mandate": {
      "type": "string",
      "expires_on": "string",
      "brokerage_from_owner": "string",
      "brokerage_from_client": "string"
    },
    "price_history": [
      {
        "at": "2026-10-06T05:30:00.000Z",
        "field": "price",
        "from": 850000000,
        "to": 850000000,
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "allowed_statuses": [
      "draft"
    ],
    "can": {
      "edit": true,
      "delete": true,
      "share": true,
      "publish": true,
      "documents": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/properties/{id}/timeline

Timeline of a listing

Status and price changes, shares and views, key movements and notes, newest first.

Access: API key with properties:read, or a member session. Permission properties.view.

Parameters

idpathrequired: Id
Opaque record id.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of PropertyTimelineItem
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/properties/{id}/timeline' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "type": "string",
      "title": "string",
      "body": "string",
      "meta": {},
      "actor": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "occurred_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/listings

Listing settings

Photo watermark, the price-per-sq-ft basis, mandate reminder days, matching and share-link rules.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.inventory or settings.view.

Response · 200

datarequired: ListingSettings
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/listings' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "watermark": {
      "enabled": true,
      "text": "string",
      "use_logo": true,
      "position": "bottom_right",
      "opacity": 0
    },
    "price_per_sqft_basis": "super",
    "mandate_reminder_days": 1,
    "matching": {
      "radius_km": 0,
      "budget_tolerance_pct": 0,
      "min_score": 0,
      "max_per_lead": 1,
      "max_per_property": 1
    },
    "shares": {
      "expiry_days": 1,
      "session_gap_minutes": 5,
      "long_dwell_seconds": 15,
      "hot_task": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/settings/listings

Change listing settings

Sections merge field by field; each changed section is audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.inventory.

Request body

watermark: object
watermark.enabled: boolean
watermark.text: string or null
Drawn when there is no logo (default: company name).
watermark.use_logo: boolean
watermark.position: "bottom_right" | "bottom_left" | "top_right" | "top_left" | "center"
watermark.opacity: number
price_per_sqft_basis: "super" | "builtup" | "carpet"
mandate_reminder_days: integer
matching: object
matching.radius_km: number
matching.budget_tolerance_pct: number
matching.min_score: integer
matching.max_per_lead: integer
matching.max_per_property: integer
shares: object
shares.expiry_days: integer
shares.session_gap_minutes: integer
shares.long_dwell_seconds: integer
shares.hot_task: boolean

Response · 200

datarequired: ListingSettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/listings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"watermark":{"enabled":true,"text":"string","use_logo":true,"position":"bottom_right","opacity":0},"price_per_sqft_basis":"super","mandate_reminder_days":1,"matching":{"radius_km":0,"budget_tolerance_pct":0,"min_score":0,"max_per_lead":1,"max_per_property":1},"shares":{"expiry_days":1,"session_gap_minutes":5,"long_dwell_seconds":15,"hot_task":true}}'

Response example

{
  "data": {
    "watermark": {
      "enabled": true,
      "text": "string",
      "use_logo": true,
      "position": "bottom_right",
      "opacity": 0
    },
    "price_per_sqft_basis": "super",
    "mandate_reminder_days": 1,
    "matching": {
      "radius_km": 0,
      "budget_tolerance_pct": 0,
      "min_score": 0,
      "max_per_lead": 1,
      "max_per_property": 1
    },
    "shares": {
      "expiry_days": 1,
      "session_gap_minutes": 5,
      "long_dwell_seconds": 15,
      "hot_task": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/properties

Create a listing

Creates a draft (or an active listing when complete). The P- reference is allocated per company.

Access: API key with properties:write, or a member session. Permission properties.create.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

listing_typerequired: ListingType
category: PropertyCategory
property_typerequired: PropertyType
title: string
Generated from the facts when left out.
description: string or null
owner_contact_id: Id or null
Opaque record id.
owner: PropertyOwnerInput or null
mandate: MandateType or null
mandate_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
owner_expected_price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
brokerage_from_owner: string or null
brokerage_from_client: string or null
key_with: "owner" | "agent" | "office" | "security" | "tenant" | "other" or null
visit_instructions: string or null
project_id: Id or null
Opaque record id.
society_name: string or null
building: string or null
unit_no: string or null
floor: integer or null
total_floors: integer or null
address: string or null
locality_id: Id or null
Opaque record id.
sub_locality: string or null
landmark: string or null
city: string
Defaults to the company's city.
state: string or null
pincode: string or null
latitude: number or null
longitude: number or null
bhk: number or null
bedrooms: integer or null
bathrooms: integer or null
layout: Layout or null
balconies: integer or null
extra_rooms: array of "study" | "servant" | "pooja" | "store"
carpet_area: number or null
builtup_area: number or null
super_area: number or null
plot_area: number or null
area_unit: AreaUnit
sqyd is gaj.
plot_length: number or null
plot_breadth: number or null
road_width_ft: number or null
frontage_ft: number or null
facing: Facing or null
is_corner: boolean
overlooking: array of "park" | "main_road" | "pool" | "club" | "garden"
vastu_compliant: boolean or null
furnishing: Furnishing or null
furnishing_items: array of "ac" | "wardrobe" | "modular_kitchen" | "geyser" | "fridge" | "washing_machine" | …
possession_status: PossessionStatus or null
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
year_built: integer or null
transaction_type: TransactionType or null
ownership: Ownership or null
approvals: map of boolean or string or null
State-aware approvals, e.g. { "khata": "A", "oc": true, "authority": "BBMP" }.
rera_number: string or null
loan_banks: array of string
covered_parking: integer or null
open_parking: integer or null
two_wheeler_parking: integer or null
amenity_ids: array of Id
Opaque record id.
water_supply: "corporation" | "borewell" | "both" | "tanker" or null
power_backup: "none" | "partial" | "full" or null
gated_community: boolean or null
price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
price_negotiable: boolean
price_on_request: boolean
all_inclusive: boolean or null
maintenance_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_period: "monthly" | "quarterly" | "yearly" | "one_time" or null
token_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
rent_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_included: boolean or null
deposit_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
deposit_months: number or null
lock_in_months: integer or null
notice_months: integer or null
agreement_months: integer or null
escalation_pct: number or null
rent_floor: PaiseInput or null
The lowest monthly rent the owner accepts (paise).
deposit_floor: PaiseInput or null
The lowest deposit the owner accepts (paise).
lock_in_max_months: integer or null
The longest lock-in the owner accepts (months).
available_from: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
tenant_preferences: array of "family" | "bachelor_male" | "bachelor_female" | "company" | "students"
pets_allowed: boolean or null
non_veg_allowed: boolean or null
listed_by_id: Id or null
Opaque record id.
co_broking: boolean
network_visibility: "private" | "company" | "network" | "public"
is_featured: boolean
expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
custom: map of any
status: "draft" | "active"

Response · 201

datarequired: PropertyDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"listing_type":"sale","category":"residential","property_type":"apartment","title":"string","description":"string","owner_contact_id":"cmusrceel0000q7kaafxqi1om","owner":{"name":"string","phone":"string","email":"name@example.com"},"mandate":"exclusive","mandate_expires_on":"2026-10-06","owner_expected_price":0,"brokerage_from_owner":"string","brokerage_from_client":"string","key_with":"owner","visit_instructions":"string","project_id":"cmusrceel0000q7kaafxqi1om","society_name":"string","building":"string","unit_no":"string","floor":0,"total_floors":0,"address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","sub_locality":"string","landmark":"string","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"bhk":0,"bedrooms":0,"bathrooms":0,"layout":"simplex","balconies":0,"extra_rooms":["study"],"carpet_area":0,"builtup_area":0,"super_area":0,"plot_area":0,"area_unit":"sqft","plot_length":0,"plot_breadth":0,"road_width_ft":0,"frontage_ft":0,"facing":"north","is_corner":true,"overlooking":["park"],"vastu_compliant":true,"furnishing":"unfurnished","furnishing_items":["ac"],"possession_status":"ready_to_move","possession_date":"2026-10-06","year_built":1800,"transaction_type":"new_booking","ownership":"freehold","approvals":{},"rera_number":"string","loan_banks":["string"],"covered_parking":0,"open_parking":0,"two_wheeler_parking":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"water_supply":"corporation","power_backup":"none","gated_community":true,"price":0,"price_negotiable":true,"price_on_request":true,"all_inclusive":true,"maintenance_amount":0,"maintenance_period":"monthly","token_amount":0,"rent_amount":0,"maintenance_included":true,"deposit_amount":0,"deposit_months":0,"lock_in_months":0,"notice_months":0,"agreement_months":0,"escalation_pct":0,"rent_floor":0,"deposit_floor":0,"lock_in_max_months":0,"available_from":"2026-10-06","tenant_preferences":["family"],"pets_allowed":true,"non_veg_allowed":true,"listed_by_id":"cmusrceel0000q7kaafxqi1om","co_broking":true,"network_visibility":"private","is_featured":true,"expires_on":"2026-10-06","custom":{},"status":"draft"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "P-2031",
    "listing_type": "sale",
    "category": "residential",
    "property_type": "apartment",
    "title": "string",
    "status": "draft",
    "bhk": 0,
    "bathrooms": 0,
    "layout": "simplex",
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "plot_area": 0,
    "area_unit": "sqft",
    "area_sqft": 0,
    "price": 850000000,
    "price_per_sqft": 850000000,
    "price_on_request": true,
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance_amount": 850000000,
    "maintenance_period": "string",
    "furnishing": "unfurnished",
    "facing": "north",
    "possession_status": "ready_to_move",
    "possession_date": "2026-10-06",
    "available_from": "2026-10-06",
    "society_name": "string",
    "sub_locality": "string",
    "city": "string",
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "latitude": 0,
    "longitude": 0,
    "location_precision": "exact",
    "cover_url": "string",
    "photos_count": 0,
    "matches_count": 0,
    "listed_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "is_featured": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "verification_badge": {
      "status": "verified",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "valid_until": "2026-10-06"
    },
    "views_count": 0,
    "shares_count": 0,
    "enquiries_count": 0,
    "visits_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "description": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "building": "string",
    "floor": 0,
    "total_floors": 0,
    "landmark": "string",
    "state": "string",
    "pincode": "string",
    "bedrooms": 0,
    "balconies": 0,
    "extra_rooms": [
      "string"
    ],
    "plot_length": 0,
    "plot_breadth": 0,
    "road_width_ft": 0,
    "frontage_ft": 0,
    "is_corner": true,
    "overlooking": [
      "string"
    ],
    "vastu_compliant": true,
    "furnishing_items": [
      "string"
    ],
    "year_built": 0,
    "transaction_type": "new_booking",
    "ownership": "freehold",
    "approvals": {},
    "rera_number": "string",
    "loan_banks": [
      "string"
    ],
    "covered_parking": 0,
    "open_parking": 0,
    "two_wheeler_parking": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "water_supply": "string",
    "power_backup": "string",
    "gated_community": true,
    "price_negotiable": true,
    "all_inclusive": true,
    "token_amount": 850000000,
    "maintenance_included": true,
    "deposit_months": 0,
    "lock_in_months": 0,
    "notice_months": 0,
    "agreement_months": 0,
    "escalation_pct": 0,
    "tenant_preferences": [
      "string"
    ],
    "pets_allowed": true,
    "non_veg_allowed": true,
    "co_broking": true,
    "network_visibility": "string",
    "expires_on": "2026-10-06",
    "custom": {},
    "created_by_id": "string",
    "owner": {
      "contact_id": "string",
      "name": "string",
      "phone": "string",
      "key_with": "string",
      "visit_instructions": "string"
    },
    "unit_no": "string",
    "address": "string",
    "owner_expected_price": 850000000,
    "rent_floor": 850000000,
    "deposit_floor": 850000000,
    "lock_in_max_months": 0,
    "mandate": {
      "type": "string",
      "expires_on": "string",
      "brokerage_from_owner": "string",
      "brokerage_from_client": "string"
    },
    "price_history": [
      {
        "at": "2026-10-06T05:30:00.000Z",
        "field": "price",
        "from": 850000000,
        "to": 850000000,
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "allowed_statuses": [
      "draft"
    ],
    "can": {
      "edit": true,
      "delete": true,
      "share": true,
      "publish": true,
      "documents": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.