Projects

New-booking project catalogue: developers, RERA numbers, configurations and price ranges.

GET/v1/projects

List projects

Filters: status, developer_id, locality_id, published; `q` searches names and RERA numbers.

Access: API key with projects:read, or a member session. Permission projects.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.
qquery: string
Free-text search.
statusquery: ProjectStatus
developer_idquery: Id
Opaque record id.
locality_idquery: Id
Opaque record id.
publishedquery: string

Response · 200

datarequired: array of ProjectSummary
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "slug": "string",
      "status": "pre_launch",
      "category": "residential",
      "property_types": [
        "apartment"
      ],
      "developer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "locality": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "city": "string"
      },
      "city": "string",
      "possession_date": "2026-10-06",
      "price_min": 850000000,
      "price_max": 850000000,
      "bhk_options": [
        0
      ],
      "rera_numbers": [
        {
          "state": "string",
          "number": "string",
          "phase": "string",
          "valid_till": "string"
        }
      ],
      "cp_brokerage_pct": 0,
      "is_own": true,
      "is_published": true,
      "cover_url": "string",
      "latitude": 0,
      "longitude": 0,
      "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/projects

Add a project

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

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

namerequired: string
developer_id: Id or null
Opaque record id.
is_own: boolean
statusrequired: ProjectStatus
category: PropertyCategory
property_types: array of PropertyType
rera_numbers: array of ReraNumber
launch_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
address: string or null
locality_id: Id or null
Opaque record id.
city: string or null
state: string or null
pincode: string or null
latitude: number or null
longitude: number or null
land_area: number or null
land_area_unit: AreaUnit or null
sqyd is gaj.
open_area_pct: number or null
towers_count: integer or null
units_count: integer or null
floors_max: integer or null
amenity_ids: array of Id
Opaque record id.
approvals: map of boolean or null
approved_banks: array of string
usps: array of string
description: string or null
cp_brokerage_pct: number or null
offers: string or null
video_url: string (uri) or null
virtual_tour_url: string (uri) or null
is_published: boolean
configurations: array of ProjectConfigurationInput

Response · 201

datarequired: ProjectDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","developer_id":"cmusrceel0000q7kaafxqi1om","is_own":true,"status":"pre_launch","category":"residential","property_types":["apartment"],"rera_numbers":[{"state":"string","number":"string","phase":"string","valid_till":"2026-10-06"}],"launch_date":"2026-10-06","possession_date":"2026-10-06","address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"land_area":0,"land_area_unit":"sqft","open_area_pct":0,"towers_count":0,"units_count":0,"floors_max":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"approvals":{},"approved_banks":["string"],"usps":["string"],"description":"string","cp_brokerage_pct":0,"offers":"string","video_url":"https://example.com","virtual_tour_url":"https://example.com","is_published":true,"configurations":[{"name":"3 BHK Premium","property_type":"apartment","bhk":0,"carpet_min":0,"carpet_max":0,"super_min":0,"super_max":0,"area_unit":"sqft","price_min":0,"price_max":0,"units_total":0,"units_available":0}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "status": "pre_launch",
    "category": "residential",
    "property_types": [
      "apartment"
    ],
    "developer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "city": "string",
    "possession_date": "2026-10-06",
    "price_min": 850000000,
    "price_max": 850000000,
    "bhk_options": [
      0
    ],
    "rera_numbers": [
      {
        "state": "string",
        "number": "string",
        "phase": "string",
        "valid_till": "string"
      }
    ],
    "cp_brokerage_pct": 0,
    "is_own": true,
    "is_published": true,
    "cover_url": "string",
    "latitude": 0,
    "longitude": 0,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "launch_date": "2026-10-06",
    "address": "string",
    "state": "string",
    "pincode": "string",
    "land_area": 0,
    "land_area_unit": "sqft",
    "open_area_pct": 0,
    "towers_count": 0,
    "units_count": 0,
    "floors_max": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "approvals": {},
    "approved_banks": [
      "string"
    ],
    "usps": [
      "string"
    ],
    "description": "string",
    "offers": "string",
    "video_url": "string",
    "virtual_tour_url": "string",
    "configurations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_min": 0,
        "carpet_max": 0,
        "super_min": 0,
        "super_max": 0,
        "area_unit": "sqft",
        "price_min": 850000000,
        "price_max": 850000000,
        "units_total": 0,
        "units_available": 0
      }
    ],
    "can": {
      "edit": true,
      "publish": true,
      "delete": true
    },
    "created_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.
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/developers

Developers

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

Parameters

qquery: string

Response · 200

datarequired: array of Developer
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "website": "string",
      "rera_promoter_numbers": [
        "string"
      ],
      "logo_url": "string",
      "notes": "string",
      "projects_count": 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.

POST/v1/projects/developers

Add a developer

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

Request body

namerequired: string
website: string (uri) or null
rera_promoter_numbers: array of string
notes: string or null

Response · 201

datarequired: Developer
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "website": "string",
    "rera_promoter_numbers": [
      "string"
    ],
    "logo_url": "string",
    "notes": "string",
    "projects_count": 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.
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/developers/{developerId}

Update a developer

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

Parameters

developerIdpathrequired: Id
Opaque record id.

Request body

name: string
website: string (uri) or null
rera_promoter_numbers: array of string
notes: string or null

Response · 200

datarequired: Developer
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/projects/developers/{developerId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","website":"https://example.com","rera_promoter_numbers":["string"],"notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "website": "string",
    "rera_promoter_numbers": [
      "string"
    ],
    "logo_url": "string",
    "notes": "string",
    "projects_count": 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}

A project

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ProjectDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "status": "pre_launch",
    "category": "residential",
    "property_types": [
      "apartment"
    ],
    "developer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "city": "string",
    "possession_date": "2026-10-06",
    "price_min": 850000000,
    "price_max": 850000000,
    "bhk_options": [
      0
    ],
    "rera_numbers": [
      {
        "state": "string",
        "number": "string",
        "phase": "string",
        "valid_till": "string"
      }
    ],
    "cp_brokerage_pct": 0,
    "is_own": true,
    "is_published": true,
    "cover_url": "string",
    "latitude": 0,
    "longitude": 0,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "launch_date": "2026-10-06",
    "address": "string",
    "state": "string",
    "pincode": "string",
    "land_area": 0,
    "land_area_unit": "sqft",
    "open_area_pct": 0,
    "towers_count": 0,
    "units_count": 0,
    "floors_max": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "approvals": {},
    "approved_banks": [
      "string"
    ],
    "usps": [
      "string"
    ],
    "description": "string",
    "offers": "string",
    "video_url": "string",
    "virtual_tour_url": "string",
    "configurations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_min": 0,
        "carpet_max": 0,
        "super_min": 0,
        "super_max": 0,
        "area_unit": "sqft",
        "price_min": 850000000,
        "price_max": 850000000,
        "units_total": 0,
        "units_available": 0
      }
    ],
    "can": {
      "edit": true,
      "publish": true,
      "delete": true
    },
    "created_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.

PATCH/v1/projects/{id}

Update a project

Publishing (is_published) needs projects.publish.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
developer_id: Id or null
Opaque record id.
is_own: boolean
status: ProjectStatus
category: PropertyCategory
property_types: array of PropertyType
rera_numbers: array of ReraNumber
launch_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
possession_date: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
address: string or null
locality_id: Id or null
Opaque record id.
city: string or null
state: string or null
pincode: string or null
latitude: number or null
longitude: number or null
land_area: number or null
land_area_unit: AreaUnit or null
sqyd is gaj.
open_area_pct: number or null
towers_count: integer or null
units_count: integer or null
floors_max: integer or null
amenity_ids: array of Id
Opaque record id.
approvals: map of boolean or null
approved_banks: array of string
usps: array of string
description: string or null
cp_brokerage_pct: number or null
offers: string or null
video_url: string (uri) or null
virtual_tour_url: string (uri) or null
is_published: boolean

Response · 200

datarequired: ProjectDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","developer_id":"cmusrceel0000q7kaafxqi1om","is_own":true,"status":"pre_launch","category":"residential","property_types":["apartment"],"rera_numbers":[{"state":"string","number":"string","phase":"string","valid_till":"2026-10-06"}],"launch_date":"2026-10-06","possession_date":"2026-10-06","address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"land_area":0,"land_area_unit":"sqft","open_area_pct":0,"towers_count":0,"units_count":0,"floors_max":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"approvals":{},"approved_banks":["string"],"usps":["string"],"description":"string","cp_brokerage_pct":0,"offers":"string","video_url":"https://example.com","virtual_tour_url":"https://example.com","is_published":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "status": "pre_launch",
    "category": "residential",
    "property_types": [
      "apartment"
    ],
    "developer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "city": "string",
    "possession_date": "2026-10-06",
    "price_min": 850000000,
    "price_max": 850000000,
    "bhk_options": [
      0
    ],
    "rera_numbers": [
      {
        "state": "string",
        "number": "string",
        "phase": "string",
        "valid_till": "string"
      }
    ],
    "cp_brokerage_pct": 0,
    "is_own": true,
    "is_published": true,
    "cover_url": "string",
    "latitude": 0,
    "longitude": 0,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "launch_date": "2026-10-06",
    "address": "string",
    "state": "string",
    "pincode": "string",
    "land_area": 0,
    "land_area_unit": "sqft",
    "open_area_pct": 0,
    "towers_count": 0,
    "units_count": 0,
    "floors_max": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "approvals": {},
    "approved_banks": [
      "string"
    ],
    "usps": [
      "string"
    ],
    "description": "string",
    "offers": "string",
    "video_url": "string",
    "virtual_tour_url": "string",
    "configurations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_min": 0,
        "carpet_max": 0,
        "super_min": 0,
        "super_max": 0,
        "area_unit": "sqft",
        "price_min": 850000000,
        "price_max": 850000000,
        "units_total": 0,
        "units_available": 0
      }
    ],
    "can": {
      "edit": true,
      "publish": true,
      "delete": true
    },
    "created_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}

Archive a project

Access: API key or member session. Permission projects.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/projects/{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.

POST/v1/projects/{id}/configurations

Add a configuration

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

namerequired: string
property_typerequired: PropertyType
bhk: number or null
carpet_min: number or null
carpet_max: number or null
super_min: number or null
super_max: number or null
area_unit: AreaUnit
sqyd is gaj.
price_min: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
price_max: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
units_total: integer or null
units_available: integer or null

Response · 201

datarequired: ProjectDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/configurations' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"3 BHK Premium","property_type":"apartment","bhk":0,"carpet_min":0,"carpet_max":0,"super_min":0,"super_max":0,"area_unit":"sqft","price_min":0,"price_max":0,"units_total":0,"units_available":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "status": "pre_launch",
    "category": "residential",
    "property_types": [
      "apartment"
    ],
    "developer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "city": "string",
    "possession_date": "2026-10-06",
    "price_min": 850000000,
    "price_max": 850000000,
    "bhk_options": [
      0
    ],
    "rera_numbers": [
      {
        "state": "string",
        "number": "string",
        "phase": "string",
        "valid_till": "string"
      }
    ],
    "cp_brokerage_pct": 0,
    "is_own": true,
    "is_published": true,
    "cover_url": "string",
    "latitude": 0,
    "longitude": 0,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "launch_date": "2026-10-06",
    "address": "string",
    "state": "string",
    "pincode": "string",
    "land_area": 0,
    "land_area_unit": "sqft",
    "open_area_pct": 0,
    "towers_count": 0,
    "units_count": 0,
    "floors_max": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "approvals": {},
    "approved_banks": [
      "string"
    ],
    "usps": [
      "string"
    ],
    "description": "string",
    "offers": "string",
    "video_url": "string",
    "virtual_tour_url": "string",
    "configurations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_min": 0,
        "carpet_max": 0,
        "super_min": 0,
        "super_max": 0,
        "area_unit": "sqft",
        "price_min": 850000000,
        "price_max": 850000000,
        "units_total": 0,
        "units_available": 0
      }
    ],
    "can": {
      "edit": true,
      "publish": true,
      "delete": true
    },
    "created_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.

PATCH/v1/projects/{id}/configurations/{configurationId}

Update a configuration

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

Parameters

idpathrequired: Id
Opaque record id.
configurationIdpathrequired: Id
Opaque record id.

Request body

name: string
property_type: PropertyType
bhk: number or null
carpet_min: number or null
carpet_max: number or null
super_min: number or null
super_max: number or null
area_unit: AreaUnit
sqyd is gaj.
price_min: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
price_max: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
units_total: integer or null
units_available: integer or null

Response · 200

datarequired: ProjectDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}/configurations/{configurationId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"3 BHK Premium","property_type":"apartment","bhk":0,"carpet_min":0,"carpet_max":0,"super_min":0,"super_max":0,"area_unit":"sqft","price_min":0,"price_max":0,"units_total":0,"units_available":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "status": "pre_launch",
    "category": "residential",
    "property_types": [
      "apartment"
    ],
    "developer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "city": "string",
    "possession_date": "2026-10-06",
    "price_min": 850000000,
    "price_max": 850000000,
    "bhk_options": [
      0
    ],
    "rera_numbers": [
      {
        "state": "string",
        "number": "string",
        "phase": "string",
        "valid_till": "string"
      }
    ],
    "cp_brokerage_pct": 0,
    "is_own": true,
    "is_published": true,
    "cover_url": "string",
    "latitude": 0,
    "longitude": 0,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "launch_date": "2026-10-06",
    "address": "string",
    "state": "string",
    "pincode": "string",
    "land_area": 0,
    "land_area_unit": "sqft",
    "open_area_pct": 0,
    "towers_count": 0,
    "units_count": 0,
    "floors_max": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "approvals": {},
    "approved_banks": [
      "string"
    ],
    "usps": [
      "string"
    ],
    "description": "string",
    "offers": "string",
    "video_url": "string",
    "virtual_tour_url": "string",
    "configurations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_min": 0,
        "carpet_max": 0,
        "super_min": 0,
        "super_max": 0,
        "area_unit": "sqft",
        "price_min": 850000000,
        "price_max": 850000000,
        "units_total": 0,
        "units_available": 0
      }
    ],
    "can": {
      "edit": true,
      "publish": true,
      "delete": true
    },
    "created_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}/configurations/{configurationId}

Remove a configuration

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

Parameters

idpathrequired: Id
Opaque record id.
configurationIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: ProjectDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "status": "pre_launch",
    "category": "residential",
    "property_types": [
      "apartment"
    ],
    "developer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "locality": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "city": "string"
    },
    "city": "string",
    "possession_date": "2026-10-06",
    "price_min": 850000000,
    "price_max": 850000000,
    "bhk_options": [
      0
    ],
    "rera_numbers": [
      {
        "state": "string",
        "number": "string",
        "phase": "string",
        "valid_till": "string"
      }
    ],
    "cp_brokerage_pct": 0,
    "is_own": true,
    "is_published": true,
    "cover_url": "string",
    "latitude": 0,
    "longitude": 0,
    "updated_at": "2026-10-06T05:30:00.000Z",
    "launch_date": "2026-10-06",
    "address": "string",
    "state": "string",
    "pincode": "string",
    "land_area": 0,
    "land_area_unit": "sqft",
    "open_area_pct": 0,
    "towers_count": 0,
    "units_count": 0,
    "floors_max": 0,
    "amenities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "category": "string",
        "icon": "string"
      }
    ],
    "approvals": {},
    "approved_banks": [
      "string"
    ],
    "usps": [
      "string"
    ],
    "description": "string",
    "offers": "string",
    "video_url": "string",
    "virtual_tour_url": "string",
    "configurations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "property_type": "apartment",
        "bhk": 0,
        "carpet_min": 0,
        "carpet_max": 0,
        "super_min": 0,
        "super_max": 0,
        "area_unit": "sqft",
        "price_min": 850000000,
        "price_max": 850000000,
        "units_total": 0,
        "units_available": 0
      }
    ],
    "can": {
      "edit": true,
      "publish": true,
      "delete": true
    },
    "created_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.

GET/v1/projects/{id}/lead-capture

Where a project’s leads come from

Meta lead forms mapped to the project (Settings → Integrations → Meta), hosted forms that tag it and lead sources whose default project it is (CMP-01).

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ProjectLeadCapture
metarequired: object

Request

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

Response example

{
  "data": {
    "meta_forms": [
      {
        "connection_id": "cmusrceel0000q7kaafxqi1om",
        "form_id": "string",
        "name": "string",
        "page_name": "string",
        "enabled": true
      }
    ],
    "forms": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_active": true
      }
    ],
    "sources": [
      {
        "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.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "slug": "string", "status": "pre_launch", "category": "residential", "property_types": [ "apartment" ], "developer": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "locality": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "city": "string" }, "city": "string", "possession_date": "2026-10-06", "price_min": 850000000, "price_max": 850000000, "bhk_options": [ 0 ], "rera_numbers": [ { "state": "string", "number": "string", "phase": "string", "valid_till": "string" } ], "cp_brokerage_pct": 0, "is_own": true, "is_published": true, "cover_url": "string", "latitude": 0, "longitude": 0, "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/projects' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","developer_id":"cmusrceel0000q7kaafxqi1om","is_own":true,"status":"pre_launch","category":"residential","property_types":["apartment"],"rera_numbers":[{"state":"string","number":"string","phase":"string","valid_till":"2026-10-06"}],"launch_date":"2026-10-06","possession_date":"2026-10-06","address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"land_area":0,"land_area_unit":"sqft","open_area_pct":0,"towers_count":0,"units_count":0,"floors_max":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"approvals":{},"approved_banks":["string"],"usps":["string"],"description":"string","cp_brokerage_pct":0,"offers":"string","video_url":"https://example.com","virtual_tour_url":"https://example.com","is_published":true,"configurations":[{"name":"3 BHK Premium","property_type":"apartment","bhk":0,"carpet_min":0,"carpet_max":0,"super_min":0,"super_max":0,"area_unit":"sqft","price_min":0,"price_max":0,"units_total":0,"units_available":0}]}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "slug": "string", "status": "pre_launch", "category": "residential", "property_types": [ "apartment" ], "developer": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "locality": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "city": "string" }, "city": "string", "possession_date": "2026-10-06", "price_min": 850000000, "price_max": 850000000, "bhk_options": [ 0 ], "rera_numbers": [ { "state": "string", "number": "string", "phase": "string", "valid_till": "string" } ], "cp_brokerage_pct": 0, "is_own": true, "is_published": true, "cover_url": "string", "latitude": 0, "longitude": 0, "updated_at": "2026-10-06T05:30:00.000Z", "launch_date": "2026-10-06", "address": "string", "state": "string", "pincode": "string", "land_area": 0, "land_area_unit": "sqft", "open_area_pct": 0, "towers_count": 0, "units_count": 0, "floors_max": 0, "amenities": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "category": "string", "icon": "string" } ], "approvals": {}, "approved_banks": [ "string" ], "usps": [ "string" ], "description": "string", "offers": "string", "video_url": "string", "virtual_tour_url": "string", "configurations": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "property_type": "apartment", "bhk": 0, "carpet_min": 0, "carpet_max": 0, "super_min": 0, "super_max": 0, "area_unit": "sqft", "price_min": 850000000, "price_max": 850000000, "units_total": 0, "units_available": 0 } ], "can": { "edit": true, "publish": true, "delete": true }, "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "website": "string", "rera_promoter_numbers": [ "string" ], "logo_url": "string", "notes": "string", "projects_count": 0 } ], "meta": {} }

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

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "website": "string", "rera_promoter_numbers": [ "string" ], "logo_url": "string", "notes": "string", "projects_count": 0 }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/projects/developers/{developerId}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","website":"https://example.com","rera_promoter_numbers":["string"],"notes":"string"}'

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","developer_id":"cmusrceel0000q7kaafxqi1om","is_own":true,"status":"pre_launch","category":"residential","property_types":["apartment"],"rera_numbers":[{"state":"string","number":"string","phase":"string","valid_till":"2026-10-06"}],"launch_date":"2026-10-06","possession_date":"2026-10-06","address":"string","locality_id":"cmusrceel0000q7kaafxqi1om","city":"string","state":"string","pincode":"string","latitude":0,"longitude":0,"land_area":0,"land_area_unit":"sqft","open_area_pct":0,"towers_count":0,"units_count":0,"floors_max":0,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"approvals":{},"approved_banks":["string"],"usps":["string"],"description":"string","cp_brokerage_pct":0,"offers":"string","video_url":"https://example.com","virtual_tour_url":"https://example.com","is_published":true}'

curl -X POST 'https://api.propzolo.com/v1/projects/{id}/configurations' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"3 BHK Premium","property_type":"apartment","bhk":0,"carpet_min":0,"carpet_max":0,"super_min":0,"super_max":0,"area_unit":"sqft","price_min":0,"price_max":0,"units_total":0,"units_available":0}'

curl -X PATCH 'https://api.propzolo.com/v1/projects/{id}/configurations/{configurationId}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"3 BHK Premium","property_type":"apartment","bhk":0,"carpet_min":0,"carpet_max":0,"super_min":0,"super_max":0,"area_unit":"sqft","price_min":0,"price_max":0,"units_total":0,"units_available":0}'

{ "data": { "meta_forms": [ { "connection_id": "cmusrceel0000q7kaafxqi1om", "form_id": "string", "name": "string", "page_name": "string", "enabled": true } ], "forms": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "is_active": true } ], "sources": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ] }, "meta": {} }