Unit inventory

GET/v1/projects/{id}/availability

Inventory availability by tower and configuration

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InventoryAvailability
metarequired: object

Request

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

Response example

{
  "data": {
    "by_tower": {
      "buckets": [
        {
          "key": "string",
          "label": "string",
          "total": 0,
          "by_status": {},
          "available_value": 850000000,
          "sold_pct": 0
        }
      ],
      "total": {
        "key": "string",
        "label": "string",
        "total": 0,
        "by_status": {},
        "available_value": 850000000,
        "sold_pct": 0
      }
    },
    "by_configuration": {
      "buckets": [
        {
          "key": "string",
          "label": "string",
          "total": 0,
          "by_status": {},
          "available_value": 850000000,
          "sold_pct": 0
        }
      ],
      "total": {
        "key": "string",
        "label": "string",
        "total": 0,
        "by_status": {},
        "available_value": 850000000,
        "sold_pct": 0
      }
    },
    "parking": [
      {
        "type": "string",
        "total": 0,
        "available": 0,
        "on_hold": 0,
        "booked": 0,
        "allocated": 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.
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/projects/{id}/inventory-items

Parking and storerooms of a project

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

Parameters

idpathrequired: Id
Opaque record id.
kindquery: InventoryItemKind
unallocatedquery: "true" | "false"

Response · 200

datarequired: array of InventoryItem
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "kind": "parking",
      "code": "string",
      "parking_type": "string",
      "level": "string",
      "area": 0,
      "area_unit": "sqft",
      "price": 850000000,
      "unit": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string"
      },
      "status": "available",
      "notes": "string",
      "hold": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "holder_member_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om"
      }
    }
  ],
  "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/projects/{id}/inventory-items

Add a range of parking slots or storerooms (existing codes are skipped)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: InventoryItemKind
rangerequired: object
range.prefixrequired: string
range.fromrequired: integer
range.torequired: integer
range.pad: integer
range.suffix: string
parking_type: ParkingType or null
level: string or null
area: number or null
area_unit: AreaUnit
sqyd is gaj.
price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

Response · 201

datarequired: object
data.createdrequired: integer
data.skippedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/inventory-items' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"parking","range":{"prefix":"string","from":0,"to":0,"pad":0,"suffix":"string"},"parking_type":"covered","level":"string","area":0,"area_unit":"sqft","price":0}'

Response example

{
  "data": {
    "created": 0,
    "skipped": 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.
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.

PATCH/v1/projects/{id}/inventory-items/{itemId}

Edit a parking slot or storeroom

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

Parameters

idpathrequired: Id
Opaque record id.
itemIdpathrequired: Id
Opaque record id.

Request body

parking_type: ParkingType or null
level: string or null
area: number or null
price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
notes: string or null

Response · 200

datarequired: InventoryItem
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}/inventory-items/{itemId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"parking_type":"covered","level":"string","area":0,"price":0,"notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "parking",
    "code": "string",
    "parking_type": "string",
    "level": "string",
    "area": 0,
    "area_unit": "sqft",
    "price": 850000000,
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string"
    },
    "status": "available",
    "notes": "string",
    "hold": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "holder_member_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om"
    }
  },
  "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/projects/{id}/inventory-items/{itemId}

Remove a parking slot or storeroom (refused while held, booked or sold)

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

Parameters

idpathrequired: Id
Opaque record id.
itemIdpathrequired: Id
Opaque record id.

Response · 200

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

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "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/projects/{id}/inventory-items/{itemId}/allocation

Allocate to a unit (or take off one with unit_id null)

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

Parameters

idpathrequired: Id
Opaque record id.
itemIdpathrequired: Id
Opaque record id.

Request body

unit_idrequired: Id or null
Opaque record id.

Response · 200

datarequired: InventoryItem
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/inventory-items/{itemId}/allocation' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "parking",
    "code": "string",
    "parking_type": "string",
    "level": "string",
    "area": 0,
    "area_unit": "sqft",
    "price": 850000000,
    "unit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "unit_no": "string"
    },
    "status": "available",
    "notes": "string",
    "hold": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "holder_member_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om"
    }
  },
  "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/projects/{id}/inventory-items/{itemId}/hold

Hold a parking slot or storeroom sold on its own

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

Parameters

idpathrequired: Id
Opaque record id.
itemIdpathrequired: Id
Opaque record id.

Request body

lead_id: Id or null
Opaque record id.
hours: integer or null
note: string or null

Response · 201

datarequired: UnitHold
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/inventory-items/{itemId}/hold' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","hours":1,"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "target": {
      "kind": "unit",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "holder_member_id": "cmusrceel0000q7kaafxqi1om",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "extension_status": "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.
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/projects/{id}/releases

Release phases of a project

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of UnitRelease
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "status": "planned",
      "notes": "string",
      "released_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "units": 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.
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/projects/{id}/releases

Plan a release phase

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

namerequired: string
notes: string or null

Response · 201

datarequired: UnitRelease
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/releases' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "status": "planned",
    "notes": "string",
    "released_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "units": 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.
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/projects/{id}/releases/{releaseId}/release

Put a planned phase on sale

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

Parameters

idpathrequired: Id
Opaque record id.
releaseIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.project_idrequired: Id
Opaque record id.
data.namerequired: string
data.statusrequired: "planned" | "released"
data.notesrequired: string or null
data.released_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.unitsrequired: integer
data.units_releasedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/releases/{releaseId}/release' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "status": "planned",
    "notes": "string",
    "released_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "units": 0,
    "units_released": 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.
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/projects/{id}/releases/{releaseId}/units

Put units into a phase (live units are refused)

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

Parameters

idpathrequired: Id
Opaque record id.
releaseIdpathrequired: Id
Opaque record id.

Request body

unit_idsrequired: array of Id
Opaque record id.

Response · 200

datarequired: object
data.addedrequired: integer
data.refusedrequired: array of object
data.refused[].idrequired: Id
Opaque record id.
data.refused[].reasonrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/releases/{releaseId}/units' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "added": 0,
    "refused": [
      {
        "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.
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/projects/{id}/releases/{releaseId}/withdraw

Take a phase off sale (only units nobody is working on)

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

Parameters

idpathrequired: Id
Opaque record id.
releaseIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.withdrawnrequired: integer
data.keptrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/releases/{releaseId}/withdraw' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "withdrawn": 0,
    "kept": 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.
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/projects/{id}/towers

Towers of a project with unit counts per status

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of Tower
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "floors": 0,
      "basement_levels": 0,
      "units_per_floor": 0,
      "stage": "string",
      "possession_date": "2026-10-06",
      "sort_order": 0,
      "units_total": 0,
      "units_by_status": {}
    }
  ],
  "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/projects/{id}/towers

Add a tower (optionally laying out its units)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

namerequired: string
floorsrequired: integer
basement_levels: integer or null
units_per_floor: integer or null
stage: string or null
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
sort_order: integer
layout: object
layout.numberingrequired: object
layout.numbering.floor_fromrequired: integer
layout.numbering.floor_torequired: integer
layout.numbering.units_per_floorrequired: integer
layout.numbering.prefix: string
layout.numbering.stack_digits: integer
layout.numbering.skip_floors: array of integer
layout.numbering.ground: "0" | "G"
layout.defaults: object
layout.defaults.configuration_id: Id or null
Opaque record id.
layout.defaults.property_type: PropertyType
layout.defaults.bhk: number or null
layout.defaults.carpet_area: number or null
layout.defaults.super_area: number or null
layout.defaults.area_unit: AreaUnit
sqyd is gaj.
layout.defaults.base_rate: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
layout.defaults.status: "available" | "not_released"

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.project_idrequired: Id
Opaque record id.
data.namerequired: string
data.floorsrequired: integer
data.basement_levelsrequired: integer or null
data.units_per_floorrequired: integer or null
data.stagerequired: string or null
data.possession_daterequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.sort_orderrequired: integer
data.units_totalrequired: integer
data.units_by_statusrequired: map of integer
data.generatedrequired: object or null
data.generated.createdrequired: integer
data.generated.skippedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/towers' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","floors":0,"basement_levels":0,"units_per_floor":1,"stage":"string","possession_date":"2026-10-06","sort_order":0,"layout":{"numbering":{"floor_from":0,"floor_to":0,"units_per_floor":1,"prefix":"string","stack_digits":1,"skip_floors":[0],"ground":"0"},"defaults":{"configuration_id":"cmusrceel0000q7kaafxqi1om","property_type":"apartment","bhk":0,"carpet_area":0,"super_area":0,"area_unit":"sqft","base_rate":0,"status":"available"}}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "floors": 0,
    "basement_levels": 0,
    "units_per_floor": 0,
    "stage": "string",
    "possession_date": "2026-10-06",
    "sort_order": 0,
    "units_total": 0,
    "units_by_status": {},
    "generated": {
      "created": 0,
      "skipped": 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.
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.

PATCH/v1/projects/{id}/towers/{towerId}

Edit a tower

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

Parameters

idpathrequired: Id
Opaque record id.
towerIdpathrequired: Id
Opaque record id.

Request body

name: string
floors: integer
basement_levels: integer or null
units_per_floor: integer or null
stage: string or null
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
sort_order: integer

Response · 200

datarequired: Tower
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}/towers/{towerId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","floors":0,"basement_levels":0,"units_per_floor":1,"stage":"string","possession_date":"2026-10-06","sort_order":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "floors": 0,
    "basement_levels": 0,
    "units_per_floor": 0,
    "stage": "string",
    "possession_date": "2026-10-06",
    "sort_order": 0,
    "units_total": 0,
    "units_by_status": {}
  },
  "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/projects/{id}/towers/{towerId}

Remove a tower and its units (refused while any is held, booked or sold)

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

Parameters

idpathrequired: Id
Opaque record id.
towerIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.units_removedrequired: integer
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "units_removed": 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.
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/projects/{id}/towers/{towerId}/grid

The tower grid: floors × stacks with every unit

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

Parameters

idpathrequired: Id
Opaque record id.
towerIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: UnitGrid
metarequired: object

Request

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

Response example

{
  "data": {
    "tower": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "floors": 0
    },
    "layout": "stacks",
    "stacks": [
      "string"
    ],
    "rows": [
      {
        "floor": 0,
        "label": "string",
        "cells": [
          "cmusrceel0000q7kaafxqi1om"
        ]
      }
    ],
    "units": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "project_id": "cmusrceel0000q7kaafxqi1om",
        "tower_id": "cmusrceel0000q7kaafxqi1om",
        "configuration_id": "cmusrceel0000q7kaafxqi1om",
        "release_id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string",
        "floor": 0,
        "stack": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_area": 0,
        "builtup_area": 0,
        "super_area": 0,
        "area_unit": "sqft",
        "facing": "north",
        "view": "string",
        "is_corner": true,
        "base_rate": 850000000,
        "floor_rise": 850000000,
        "total_price": 850000000,
        "status": "available",
        "blocked_reason": "string",
        "hold": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "created_at": "2026-10-06T05:30:00.000Z",
          "mine": true,
          "holder": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string",
            "kind": "member"
          },
          "lead": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "number": 0
          },
          "extension_status": "string",
          "extension_hours": 0,
          "note": "string"
        },
        "items": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "kind": "string",
            "code": "string",
            "parking_type": "string",
            "level": "string",
            "status": "available"
          }
        ],
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "truncated": 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.

POST/v1/projects/{id}/towers/{towerId}/units

Add one unit to a tower

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

Parameters

idpathrequired: Id
Opaque record id.
towerIdpathrequired: Id
Opaque record id.

Request body

unit_norequired: string
floor: integer or null
stack: string or null
configuration_id: Id or null
Opaque record id.
property_type: PropertyType
bhk: number or null
carpet_area: number or null
builtup_area: number or null
super_area: number or null
area_unit: AreaUnit
sqyd is gaj.
facing: Facing or null
view: string or null
is_corner: boolean
base_rate: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
floor_rise: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
total_price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

Response · 201

datarequired: Unit
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/towers/{towerId}/units' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_no":"string","floor":0,"stack":"string","configuration_id":"cmusrceel0000q7kaafxqi1om","property_type":"apartment","bhk":0,"carpet_area":0,"builtup_area":0,"super_area":0,"area_unit":"sqft","facing":"north","view":"string","is_corner":true,"base_rate":0,"floor_rise":0,"total_price":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "tower_id": "cmusrceel0000q7kaafxqi1om",
    "configuration_id": "cmusrceel0000q7kaafxqi1om",
    "release_id": "cmusrceel0000q7kaafxqi1om",
    "unit_no": "string",
    "floor": 0,
    "stack": "string",
    "property_type": "apartment",
    "bhk": 0,
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "area_unit": "sqft",
    "facing": "north",
    "view": "string",
    "is_corner": true,
    "base_rate": 850000000,
    "floor_rise": 850000000,
    "total_price": 850000000,
    "status": "available",
    "blocked_reason": "string",
    "hold": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "mine": true,
      "holder": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "kind": "member"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "extension_status": "string",
      "extension_hours": 0,
      "note": "string"
    },
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "code": "string",
        "parking_type": "string",
        "level": "string",
        "status": "available"
      }
    ],
    "updated_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/projects/{id}/towers/{towerId}/units/generate

Lay out units by a numbering scheme (existing numbers are kept)

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

Parameters

idpathrequired: Id
Opaque record id.
towerIdpathrequired: Id
Opaque record id.

Request body

numberingrequired: object
numbering.floor_fromrequired: integer
numbering.floor_torequired: integer
numbering.units_per_floorrequired: integer
numbering.prefix: string
numbering.stack_digits: integer
numbering.skip_floors: array of integer
numbering.ground: "0" | "G"
defaults: object
defaults.configuration_id: Id or null
Opaque record id.
defaults.property_type: PropertyType
defaults.bhk: number or null
defaults.carpet_area: number or null
defaults.super_area: number or null
defaults.area_unit: AreaUnit
sqyd is gaj.
defaults.base_rate: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
defaults.status: "available" | "not_released"

Response · 200

datarequired: object
data.createdrequired: integer
data.skippedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/towers/{towerId}/units/generate' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"numbering":{"floor_from":0,"floor_to":0,"units_per_floor":1,"prefix":"string","stack_digits":1,"skip_floors":[0],"ground":"0"},"defaults":{"configuration_id":"cmusrceel0000q7kaafxqi1om","property_type":"apartment","bhk":0,"carpet_area":0,"super_area":0,"area_unit":"sqft","base_rate":0,"status":"available"}}'

Response example

{
  "data": {
    "created": 0,
    "skipped": 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.
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/projects/{id}/units

Units of a project (the grid’s list view), filtered

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

Parameters

idpathrequired: Id
Opaque record id.
tower_idquery: Id
Opaque record id.
statusquery: array of UnitStatus
configuration_idquery: array of Id
facingquery: array of Facing
floor_minquery: integer
floor_maxquery: integer
price_minquery: integer
price_maxquery: integer
qquery: string

Response · 200

datarequired: object
data.unitsrequired: array of Unit
data.truncatedrequired: boolean
metarequired: object

Request

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

Response example

{
  "data": {
    "units": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "project_id": "cmusrceel0000q7kaafxqi1om",
        "tower_id": "cmusrceel0000q7kaafxqi1om",
        "configuration_id": "cmusrceel0000q7kaafxqi1om",
        "release_id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string",
        "floor": 0,
        "stack": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_area": 0,
        "builtup_area": 0,
        "super_area": 0,
        "area_unit": "sqft",
        "facing": "north",
        "view": "string",
        "is_corner": true,
        "base_rate": 850000000,
        "floor_rise": 850000000,
        "total_price": 850000000,
        "status": "available",
        "blocked_reason": "string",
        "hold": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "created_at": "2026-10-06T05:30:00.000Z",
          "mine": true,
          "holder": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string",
            "kind": "member"
          },
          "lead": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "number": 0
          },
          "extension_status": "string",
          "extension_hours": 0,
          "note": "string"
        },
        "items": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "kind": "string",
            "code": "string",
            "parking_type": "string",
            "level": "string",
            "status": "available"
          }
        ],
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "truncated": 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.

POST/v1/projects/{id}/units/bulk-status

Block, unblock or hold back many units (live units are skipped)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

unit_idsrequired: array of Id
Opaque record id.
statusrequired: "blocked" | "available" | "not_released"
reason: string or null

Response · 200

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

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/units/bulk-status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_ids":["cmusrceel0000q7kaafxqi1om"],"status":"blocked","reason":"string"}'

Response example

{
  "data": {
    "changed": 0,
    "skipped": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string",
        "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.
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/projects/{id}/units/import

Import units from the builder’s sheet (dry run, then apply)

multipart/form-data: `file` (CSV / XLSX, ≤ 5 MB, ≤ 5,000 rows), `mode` (`dry_run` — the default — or `apply`) and an optional `mapping` (JSON: field → column index; the dry run suggests one). Applying upserts by tower + unit number, so re-importing the same sheet changes nothing; held, booked and sold units keep their status.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: UnitImportPreview or UnitImportResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/units/import' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "headers": [
      "string"
    ],
    "mapping": {},
    "problems": [
      "string"
    ],
    "new_towers": [
      "string"
    ],
    "counts": {
      "rows": 0,
      "create": 0,
      "update": 0,
      "unchanged": 0,
      "duplicate": 0,
      "invalid": 0,
      "status_kept": 0
    },
    "rows": [
      {
        "row": 0,
        "tower": "string",
        "unit_no": "string",
        "action": "create",
        "changed": [
          "string"
        ],
        "status_kept": true,
        "errors": [
          {
            "field": null,
            "message": null
          }
        ],
        "warnings": [
          {
            "field": null,
            "message": null
          }
        ]
      }
    ]
  },
  "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/projects/{id}/units/{unitId}

One unit with its hold history and parking

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

Parameters

idpathrequired: Id
Opaque record id.
unitIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: UnitDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "tower_id": "cmusrceel0000q7kaafxqi1om",
    "configuration_id": "cmusrceel0000q7kaafxqi1om",
    "release_id": "cmusrceel0000q7kaafxqi1om",
    "unit_no": "string",
    "floor": 0,
    "stack": "string",
    "property_type": "apartment",
    "bhk": 0,
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "area_unit": "sqft",
    "facing": "north",
    "view": "string",
    "is_corner": true,
    "base_rate": 850000000,
    "floor_rise": 850000000,
    "total_price": 850000000,
    "status": "available",
    "blocked_reason": "string",
    "hold": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "mine": true,
      "holder": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "kind": "member"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "extension_status": "string",
      "extension_hours": 0,
      "note": "string"
    },
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "code": "string",
        "parking_type": "string",
        "level": "string",
        "status": "available"
      }
    ],
    "updated_at": "2026-10-06T05:30:00.000Z",
    "tower": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "release": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "status": "string"
    },
    "configuration": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "plc": null,
    "holds": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "ended_at": "2026-10-06T05:30:00.000Z",
        "release_reason": "string",
        "release_label": "string",
        "extension_status": "string",
        "lead": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "number": 0
        },
        "holder": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "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.
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/projects/{id}/units/{unitId}

Edit a unit (prices need units.price_edit)

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

Parameters

idpathrequired: Id
Opaque record id.
unitIdpathrequired: Id
Opaque record id.

Request body

unit_no: string
floor: integer or null
stack: string or null
configuration_id: Id or null
Opaque record id.
property_type: PropertyType
bhk: number or null
carpet_area: number or null
builtup_area: number or null
super_area: number or null
area_unit: AreaUnit
sqyd is gaj.
facing: Facing or null
view: string or null
is_corner: boolean
base_rate: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
floor_rise: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
total_price: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

Response · 200

datarequired: Unit
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}/units/{unitId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"unit_no":"string","floor":0,"stack":"string","configuration_id":"cmusrceel0000q7kaafxqi1om","property_type":"apartment","bhk":0,"carpet_area":0,"builtup_area":0,"super_area":0,"area_unit":"sqft","facing":"north","view":"string","is_corner":true,"base_rate":0,"floor_rise":0,"total_price":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "tower_id": "cmusrceel0000q7kaafxqi1om",
    "configuration_id": "cmusrceel0000q7kaafxqi1om",
    "release_id": "cmusrceel0000q7kaafxqi1om",
    "unit_no": "string",
    "floor": 0,
    "stack": "string",
    "property_type": "apartment",
    "bhk": 0,
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "area_unit": "sqft",
    "facing": "north",
    "view": "string",
    "is_corner": true,
    "base_rate": 850000000,
    "floor_rise": 850000000,
    "total_price": 850000000,
    "status": "available",
    "blocked_reason": "string",
    "hold": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "mine": true,
      "holder": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "kind": "member"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "extension_status": "string",
      "extension_hours": 0,
      "note": "string"
    },
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "code": "string",
        "parking_type": "string",
        "level": "string",
        "status": "available"
      }
    ],
    "updated_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.

DELETE/v1/projects/{id}/units/{unitId}

Remove a unit (refused while held, booked, sold or linked to a deal)

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

Parameters

idpathrequired: Id
Opaque record id.
unitIdpathrequired: Id
Opaque record id.

Response · 200

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

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "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/projects/{id}/units/{unitId}/hold

Hold an available unit (atomic; 409 when someone else got it first)

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

Parameters

idpathrequired: Id
Opaque record id.
unitIdpathrequired: Id
Opaque record id.

Request body

lead_id: Id or null
Opaque record id.
hours: integer or null
note: string or null

Response · 201

datarequired: UnitHold
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/units/{unitId}/hold' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","hours":1,"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "target": {
      "kind": "unit",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "holder_member_id": "cmusrceel0000q7kaafxqi1om",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "extension_status": "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.
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/projects/{id}/units/{unitId}/status

Change a unit’s status by hand (blocking needs a reason; booking converts a hold)

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

Parameters

idpathrequired: Id
Opaque record id.
unitIdpathrequired: Id
Opaque record id.

Request body

statusrequired: "available" | "blocked" | "booked" | "sold" | "not_released" | "landowner_share" | …
reason: string or null

Response · 200

datarequired: Unit
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/units/{unitId}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"available","reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "tower_id": "cmusrceel0000q7kaafxqi1om",
    "configuration_id": "cmusrceel0000q7kaafxqi1om",
    "release_id": "cmusrceel0000q7kaafxqi1om",
    "unit_no": "string",
    "floor": 0,
    "stack": "string",
    "property_type": "apartment",
    "bhk": 0,
    "carpet_area": 0,
    "builtup_area": 0,
    "super_area": 0,
    "area_unit": "sqft",
    "facing": "north",
    "view": "string",
    "is_corner": true,
    "base_rate": 850000000,
    "floor_rise": 850000000,
    "total_price": 850000000,
    "status": "available",
    "blocked_reason": "string",
    "hold": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "mine": true,
      "holder": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "kind": "member"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "extension_status": "string",
      "extension_hours": 0,
      "note": "string"
    },
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "code": "string",
        "parking_type": "string",
        "level": "string",
        "status": "available"
      }
    ],
    "updated_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.

GET/v1/settings/unit-holds

Unit hold settings

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

Response · 200

datarequired: UnitHoldPolicy
metarequired: object

Request

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

Response example

{
  "data": {
    "default_hours": 1,
    "max_hours": 1,
    "role_max_hours": {},
    "max_active_per_member": 1,
    "allow_extension": true,
    "extension_hours": 1,
    "warn_before_minutes": 0,
    "require_lead": 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/unit-holds

Change unit hold settings

The default hold cannot be longer than the longest hold.

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

Request body

default_hours: integer
max_hours: integer
role_max_hours: map of integer
max_active_per_member: integer
allow_extension: boolean
extension_hours: integer
warn_before_minutes: integer
require_lead: boolean

Response · 200

datarequired: UnitHoldPolicy
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/unit-holds' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"default_hours":1,"max_hours":1,"role_max_hours":{},"max_active_per_member":1,"allow_extension":true,"extension_hours":1,"warn_before_minutes":0,"require_lead":true}'

Response example

{
  "data": {
    "default_hours": 1,
    "max_hours": 1,
    "role_max_hours": {},
    "max_active_per_member": 1,
    "allow_extension": true,
    "extension_hours": 1,
    "warn_before_minutes": 0,
    "require_lead": 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/unit-holds

Running holds: mine, or every hold within my release scope (pending extensions first)

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

Parameters

minequery: "true" | "false"
project_idquery: Id
Opaque record id.

Response · 200

datarequired: array of UnitHoldListItem
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "target": {
        "kind": "unit",
        "id": "cmusrceel0000q7kaafxqi1om",
        "label": "string"
      },
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "holder_member_id": "cmusrceel0000q7kaafxqi1om",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "extension_status": "string",
      "mine": true,
      "holder": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "extension_hours": 0,
      "time_left": "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.
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/unit-holds/{id}/extension

Ask for the one extension a hold may get (the holder)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

hours: integer or null
reason: string or null

Response · 200

datarequired: UnitHold
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/unit-holds/{id}/extension' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"hours":1,"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "target": {
      "kind": "unit",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "holder_member_id": "cmusrceel0000q7kaafxqi1om",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "extension_status": "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.
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/unit-holds/{id}/extension/decision

Approve or deny an extension — or grant one unasked (a manager, never the holder)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

approverequired: boolean
hours: integer or null

Response · 200

datarequired: UnitHold
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/unit-holds/{id}/extension/decision' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"approve":true,"hours":1}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "target": {
      "kind": "unit",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "holder_member_id": "cmusrceel0000q7kaafxqi1om",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "extension_status": "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.
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/unit-holds/{id}/release

Release a hold (the holder, or a manager within units.release scope)

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: UnitHold
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/unit-holds/{id}/release' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "target": {
      "kind": "unit",
      "id": "cmusrceel0000q7kaafxqi1om",
      "label": "string"
    },
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "holder_member_id": "cmusrceel0000q7kaafxqi1om",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "extension_status": "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.
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.