Broker network

The co-broking network (N-03): the network profile with RERA / KYC badges and trust signals, the directory, circles, masked shares of listings and requirements with availability checks, matches, co-broke deals with frozen split terms, deal rooms and client registration locks.

GET/v1/network/availability-checks

Availability checks

Pings to answer (inbound, pending first) and pings sent.

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

Parameters

directionquery: "inbound" | "outbound"

Response · 200

datarequired: array of NetworkAvailabilityCheck
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "direction": "inbound",
      "share": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "status": "pending",
      "asked_at": "2026-10-06T05:30:00.000Z",
      "answered_at": "2026-10-06T05:30:00.000Z",
      "answer_note": "string",
      "broker": {
        "profile_id": "cmusrceel0000q7kaafxqi1om",
        "display_name": "string",
        "city": "string",
        "rera_badge": "verified",
        "kyc_verified": true,
        "trust_level": "new"
      }
    }
  ],
  "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/network/availability-checks/{id}/answer

Answer an availability check

Available re-confirms the share (15-day clock); not available closes it.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

availablerequired: boolean
note: string or null

Response · 200

datarequired: NetworkAvailabilityCheck
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/availability-checks/{id}/answer' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"available":true,"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "direction": "inbound",
    "share": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string"
    },
    "status": "pending",
    "asked_at": "2026-10-06T05:30:00.000Z",
    "answered_at": "2026-10-06T05:30:00.000Z",
    "answer_note": "string",
    "broker": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    }
  },
  "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/network/circle-memberships/{id}

Answer an invitation or a join request, leave or remove

Invitee: accept / decline; owner: approve / reject a request, remove a member; member: leave. Leaving hides the circle’s shares.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "accept" | "decline" | "approve" | "reject" | "leave" | "remove"

Response · 200

datarequired: NetworkCircle
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/circle-memberships/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"accept"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "micro_market",
    "city": "string",
    "description": "string",
    "discoverable": true,
    "status": "active",
    "owner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "is_owner": true,
    "membership": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "invited"
    },
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "invited",
        "broker": {
          "profile_id": "cmusrceel0000q7kaafxqi1om",
          "display_name": "string",
          "city": "string",
          "rera_badge": "verified",
          "kyc_verified": true,
          "trust_level": "new"
        },
        "joined_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "active_members": 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/network/circles

Circles

Circles the company runs or belongs to, invitations, and discoverable circles it may ask to join.

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

Response · 200

datarequired: array of NetworkCircle
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "micro_market",
      "city": "string",
      "description": "string",
      "discoverable": true,
      "status": "active",
      "owner": {
        "profile_id": "cmusrceel0000q7kaafxqi1om",
        "display_name": "string",
        "city": "string",
        "rera_badge": "verified",
        "kyc_verified": true,
        "trust_level": "new"
      },
      "is_owner": true,
      "membership": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "invited"
      },
      "members": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "status": "invited",
          "broker": {
            "profile_id": "cmusrceel0000q7kaafxqi1om",
            "display_name": "string",
            "city": "string",
            "rera_badge": "verified",
            "kyc_verified": true,
            "trust_level": "new"
          },
          "joined_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "active_members": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/network/circles

Start a circle

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

Request body

namerequired: string
kind: "micro_market" | "association" | "custom"
city: string or null
description: string or null
discoverable: boolean

Response · 201

datarequired: NetworkCircle
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/circles' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","kind":"custom","city":"string","description":"string","discoverable":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "micro_market",
    "city": "string",
    "description": "string",
    "discoverable": true,
    "status": "active",
    "owner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "is_owner": true,
    "membership": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "invited"
    },
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "invited",
        "broker": {
          "profile_id": "cmusrceel0000q7kaafxqi1om",
          "display_name": "string",
          "city": "string",
          "rera_badge": "verified",
          "kyc_verified": true,
          "trust_level": "new"
        },
        "joined_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "active_members": 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.

POST/v1/network/circles/{id}/members

Invite a company, or ask to join

The owner invites a listed company (`profile_id`); any other company asks to join a discoverable circle (no body fields).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

profile_id: Id or null
Opaque record id.

Response · 200

datarequired: NetworkCircle
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/circles/{id}/members' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"profile_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "micro_market",
    "city": "string",
    "description": "string",
    "discoverable": true,
    "status": "active",
    "owner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "is_owner": true,
    "membership": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "invited"
    },
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "invited",
        "broker": {
          "profile_id": "cmusrceel0000q7kaafxqi1om",
          "display_name": "string",
          "city": "string",
          "rera_badge": "verified",
          "kyc_verified": true,
          "trust_level": "new"
        },
        "joined_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "active_members": 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/network/co-brokes

Co-broke deals

Requests sent and received; open ones (requested, negotiating, agreed) by default. Latest activity first.

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

Parameters

statusquery: "open" | "closed" | "all"
sidequery: "requester" | "owner"

Response · 200

datarequired: array of CoBroke
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "side": "requester",
      "status": "requested",
      "share_id": "cmusrceel0000q7kaafxqi1om",
      "share": {
        "kind": "listing",
        "title": "string",
        "deal_side": "sale",
        "city": "string",
        "localities": [
          "string"
        ],
        "price_min": 850000000,
        "price_max": 850000000,
        "live": true
      },
      "partner": {
        "profile_id": "cmusrceel0000q7kaafxqi1om",
        "display_name": "string",
        "city": "string",
        "rera_badge": "verified",
        "kyc_verified": true,
        "trust_level": "new"
      },
      "message": "string",
      "terms": {
        "basis": "pooled",
        "requester_share_bps": 0,
        "note": "string",
        "version": 0,
        "proposed_by": "requester",
        "requester_accepted_at": "2026-10-06T05:30:00.000Z",
        "owner_accepted_at": "2026-10-06T05:30:00.000Z"
      },
      "agreed_at": "2026-10-06T05:30:00.000Z",
      "my_deal_id": "cmusrceel0000q7kaafxqi1om",
      "closed_at": "2026-10-06T05:30:00.000Z",
      "close_note": "string",
      "dispute": {
        "opened_at": "2026-10-06T05:30:00.000Z",
        "opened_by": "requester",
        "reason": "string",
        "resolved_at": "2026-10-06T05:30:00.000Z",
        "resolution": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "last_activity_at": "2026-10-06T05:30:00.000Z",
      "esign": {
        "status": "none",
        "requested_by": "me",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "error": "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/network/co-brokes

Ask to co-broke a shared item

One open request per shared item. The sharer has 7 days to answer.

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

Request body

share_idrequired: Id
Opaque record id.
message: string or null

Response · 201

datarequired: CoBroke
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"share_id":"cmusrceel0000q7kaafxqi1om","message":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    }
  },
  "meta": {}
}

Errors

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

GET/v1/network/co-brokes/{id}

A deal room

The co-broke with its thread, documents and client registrations.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: CoBrokeDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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.

POST/v1/network/co-brokes/{id}/actions

Move a co-broke

Owner: accept / decline; requester: withdraw; either: propose terms (`terms`), accept the other side’s terms (both accepted = agreed; the terms are then frozen), close an agreed co-broke as won or lost.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "accept" | "decline" | "withdraw" | "propose_terms" | "accept_terms" | "close_won" | …
terms: object or null
terms.basisrequired: "pooled" | "own_client"
terms.requester_share_bps: integer or null
terms.note: string or null
terms_version: integer or null
note: string or null

Response · 200

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/actions' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"accept","terms":{"basis":"pooled","requester_share_bps":0,"note":"string"},"terms_version":1,"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/co-brokes/{id}/dispute

Raise or settle a dispute

Either side raises a dispute on an agreed or closed co-broke; either side records the settlement.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "open" | "resolve"
textrequired: string

Response · 200

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/dispute' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"open","text":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/co-brokes/{id}/documents

Add an uploaded document to the deal room

Both sides can download it unless the malware scan quarantines it.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

storage_keyrequired: string
filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 201

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/documents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"storage_key":"string","filename":"string","content_type":"string","size":1}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/co-brokes/{id}/documents/uploads

Upload URL for a deal room document

PDF or image, up to 15 MB, to this company’s private storage.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

content_typerequired: string
sizerequired: integer
filename: string or null

Response · 200

datarequired: object
data.storage_keyrequired: string
data.urlrequired: string
data.methodrequired: "PUT"
data.headersrequired: map of string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/documents/uploads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"content_type":"string","size":1,"filename":"string"}'

Response example

{
  "data": {
    "storage_key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_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/network/co-brokes/{id}/documents/{documentId}/download

Download a deal room document

A short-lived URL; 403 when the malware scan quarantined the file, 404 for anyone but the two companies.

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/network/co-brokes/{id}/documents/{documentId}/download' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

POST/v1/network/co-brokes/{id}/esign

E-sign the agreed terms (optional)

Freezes the agreed terms into a PDF and sends it to both brokers for electronic signature at PropZolo’s e-sign partner (signers: each network profile’s business phone or email). The signed copy lands in the deal room’s documents.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 202

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/esign' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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.

POST/v1/network/co-brokes/{id}/esign/sign

Open this broker’s signing page

A short-lived link to the e-sign partner’s page for this company’s signer; never stored.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/esign/sign' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "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.

POST/v1/network/co-brokes/{id}/link-deal

Link the company’s own deal

Links this side’s CRM deal; on a pooled agreement the deal’s co-broker share becomes the partner’s agreed share (the partner company as a broker contact), so the commission net and splits follow.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

deal_idrequired: Id
Opaque record id.

Response · 200

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/link-deal' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"deal_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/co-brokes/{id}/messages

Write in the deal room

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

bodyrequired: string

Response · 201

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/messages' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"body":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/co-brokes/{id}/registrations

Register a client with the sharer

Locks the client to this company on the shared item for the sharer’s lock window (30–180 days). The sharer sees a masked label only. First come, first served across the network: 409 names the holder until when; send `dispute_reason` to file a dispute the sharer decides.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

contact_idrequired: Id
Opaque record id.
dispute_reason: string or null

Response · 201

datarequired: CoBrokeDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/co-brokes/{id}/registrations' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","dispute_reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/directory

The broker directory

Listed companies, trusted first; search by name or area, filter by city and speciality.

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

Parameters

qquery: string
cityquery: string
specialityquery: "resale" | "rental" | "new_projects" | "commercial" | "plots" | "luxury" | …

Response · 200

datarequired: array of NetworkDirectoryEntry
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "about": "string",
      "city": "string",
      "areas": [
        "string"
      ],
      "specialities": [
        "string"
      ],
      "languages": [
        "string"
      ],
      "rera": {
        "number": "string",
        "state": "string",
        "expires_on": "2026-10-06",
        "badge": "verified"
      },
      "kyc_verified": true,
      "trust": {
        "level": "new",
        "response_rate_pct": 0,
        "median_response_minutes": 0,
        "co_brokes_closed": 0,
        "co_brokes_disputed": 0,
        "verified_listings": 0,
        "active_shares": 0,
        "refreshed_at": "2026-10-06T05:30:00.000Z"
      },
      "listed_at": "2026-10-06T05:30:00.000Z",
      "is_me": 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.
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/network/feed

Shares from the network

Other companies’ live shares this company may see (the network, and circles it is an active member of).

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

Parameters

kindquery: "listing" | "requirement"
sidequery: "sale" | "rent"
cityquery: string
circle_idquery: Id
Opaque record id.
qquery: string

Response · 200

datarequired: array of NetworkShare
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "category": "string",
      "property_types": [
        "string"
      ],
      "bhk": [
        0
      ],
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "area_min_sqft": 0,
      "area_max_sqft": 0,
      "verified": true,
      "summary": {
        "furnishing": [
          "string"
        ],
        "possession": "string",
        "available_from": "string"
      },
      "co_broke_terms": "string",
      "offered_split_bps": 0,
      "visibility": "circle",
      "circle": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "status": "active",
      "freshness": "fresh",
      "last_confirmed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "mine": true,
      "broker": {
        "profile_id": "cmusrceel0000q7kaafxqi1om",
        "display_name": "string",
        "city": "string",
        "rera_badge": "verified",
        "kyc_verified": true,
        "trust_level": "new"
      },
      "source": {
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "ref": "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.

GET/v1/network/matches

Matches across the network

The company’s shared requirements against other companies’ shared listings, and its shared listings against their requirements. Best first.

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

Parameters

share_idquery: Id
Opaque record id.

Response · 200

datarequired: array of NetworkMatch
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "score": 0,
      "reasons": [
        "locality"
      ],
      "mine": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "listing",
        "title": "string",
        "deal_side": "sale",
        "category": "string",
        "property_types": [
          "string"
        ],
        "bhk": [
          0
        ],
        "city": "string",
        "localities": [
          "string"
        ],
        "price_min": 850000000,
        "price_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "verified": true,
        "summary": {
          "furnishing": [
            "string"
          ],
          "possession": "string",
          "available_from": "string"
        },
        "co_broke_terms": "string",
        "offered_split_bps": 0,
        "visibility": "circle",
        "circle": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "status": "active",
        "freshness": "fresh",
        "last_confirmed_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "mine": true,
        "broker": {
          "profile_id": "cmusrceel0000q7kaafxqi1om",
          "display_name": "string",
          "city": "string",
          "rera_badge": "verified",
          "kyc_verified": true,
          "trust_level": "new"
        },
        "source": {
          "property_id": "cmusrceel0000q7kaafxqi1om",
          "lead_id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string"
        }
      },
      "theirs": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "listing",
        "title": "string",
        "deal_side": "sale",
        "category": "string",
        "property_types": [
          "string"
        ],
        "bhk": [
          0
        ],
        "city": "string",
        "localities": [
          "string"
        ],
        "price_min": 850000000,
        "price_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "verified": true,
        "summary": {
          "furnishing": [
            "string"
          ],
          "possession": "string",
          "available_from": "string"
        },
        "co_broke_terms": "string",
        "offered_split_bps": 0,
        "visibility": "circle",
        "circle": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "status": "active",
        "freshness": "fresh",
        "last_confirmed_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "mine": true,
        "broker": {
          "profile_id": "cmusrceel0000q7kaafxqi1om",
          "display_name": "string",
          "city": "string",
          "rera_badge": "verified",
          "kyc_verified": true,
          "trust_level": "new"
        },
        "source": {
          "property_id": "cmusrceel0000q7kaafxqi1om",
          "lead_id": "cmusrceel0000q7kaafxqi1om",
          "ref": "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.

GET/v1/network/profile

The company’s network profile

Null until the company sets one up. Trust facts are recomputed daily by PropZolo.

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

Response · 200

datarequired: NetworkProfile or null
metarequired: object

Request

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

Response example

{
  "data": {
    "profile_id": "cmusrceel0000q7kaafxqi1om",
    "display_name": "string",
    "about": "string",
    "city": "string",
    "areas": [
      "string"
    ],
    "specialities": [
      "string"
    ],
    "languages": [
      "string"
    ],
    "rera": {
      "number": "string",
      "state": "string",
      "expires_on": "2026-10-06",
      "badge": "verified"
    },
    "kyc_verified": true,
    "trust": {
      "level": "new",
      "response_rate_pct": 0,
      "median_response_minutes": 0,
      "co_brokes_closed": 0,
      "co_brokes_disputed": 0,
      "verified_listings": 0,
      "active_shares": 0,
      "refreshed_at": "2026-10-06T05:30:00.000Z"
    },
    "listed_at": "2026-10-06T05:30:00.000Z",
    "is_me": true,
    "status": "draft",
    "business_phone": "string",
    "business_email": "string",
    "kyc_status": "none",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "kyc_note": "string",
    "lock_days": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/network/profile

Set up or edit the network profile

`listed` shows the company in the directory (needs a business phone or email). A new RERA number or validity drops PropZolo’s verification until checked again.

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

Request body

statusrequired: "draft" | "listed" | "paused"
display_namerequired: string
about: string or null
cityrequired: string
areas: array of string
specialities: array of "resale" | "rental" | "new_projects" | "commercial" | "plots" | "luxury" | …
languages: array of string
business_phone: PhoneE164 or null
Phone number in E.164 format.
business_email: string (email) or null
rera_number: string or null
rera_state: string or null
rera_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
lock_days: integer

Response · 200

datarequired: NetworkProfile
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/network/profile' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"draft","display_name":"string","about":"string","city":"string","areas":[],"specialities":[],"languages":[],"business_phone":"+919812345678","business_email":"name@example.com","rera_number":"string","rera_state":"string","rera_expires_on":"2026-10-06","lock_days":90}'

Response example

{
  "data": {
    "profile_id": "cmusrceel0000q7kaafxqi1om",
    "display_name": "string",
    "about": "string",
    "city": "string",
    "areas": [
      "string"
    ],
    "specialities": [
      "string"
    ],
    "languages": [
      "string"
    ],
    "rera": {
      "number": "string",
      "state": "string",
      "expires_on": "2026-10-06",
      "badge": "verified"
    },
    "kyc_verified": true,
    "trust": {
      "level": "new",
      "response_rate_pct": 0,
      "median_response_minutes": 0,
      "co_brokes_closed": 0,
      "co_brokes_disputed": 0,
      "verified_listings": 0,
      "active_shares": 0,
      "refreshed_at": "2026-10-06T05:30:00.000Z"
    },
    "listed_at": "2026-10-06T05:30:00.000Z",
    "is_me": true,
    "status": "draft",
    "business_phone": "string",
    "business_email": "string",
    "kyc_status": "none",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "kyc_note": "string",
    "lock_days": 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.

POST/v1/network/profile/kyc

Submit KYC for verification

The uploaded document goes to PropZolo’s review; the badge shows once verified.

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

Request body

storage_keyrequired: string

Response · 200

datarequired: NetworkProfile
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/profile/kyc' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"storage_key":"string"}'

Response example

{
  "data": {
    "profile_id": "cmusrceel0000q7kaafxqi1om",
    "display_name": "string",
    "about": "string",
    "city": "string",
    "areas": [
      "string"
    ],
    "specialities": [
      "string"
    ],
    "languages": [
      "string"
    ],
    "rera": {
      "number": "string",
      "state": "string",
      "expires_on": "2026-10-06",
      "badge": "verified"
    },
    "kyc_verified": true,
    "trust": {
      "level": "new",
      "response_rate_pct": 0,
      "median_response_minutes": 0,
      "co_brokes_closed": 0,
      "co_brokes_disputed": 0,
      "verified_listings": 0,
      "active_shares": 0,
      "refreshed_at": "2026-10-06T05:30:00.000Z"
    },
    "listed_at": "2026-10-06T05:30:00.000Z",
    "is_me": true,
    "status": "draft",
    "business_phone": "string",
    "business_email": "string",
    "kyc_status": "none",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "kyc_note": "string",
    "lock_days": 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.

POST/v1/network/profile/kyc/uploads

Upload URL for the KYC document

A PDF or photo of the firm’s registration / PAN / RERA certificate, to the company’s private storage.

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

Request body

content_typerequired: string
sizerequired: integer
filename: string or null

Response · 200

datarequired: object
data.storage_keyrequired: string
data.urlrequired: string
data.methodrequired: "PUT"
data.headersrequired: map of string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/profile/kyc/uploads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"content_type":"string","size":1,"filename":"string"}'

Response example

{
  "data": {
    "storage_key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_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.

POST/v1/network/registrations/{id}

Release, reject or decide a registration

Registering company: release. Sharer: reject (e.g. already its own client), or decide a dispute — keep the existing lock, award the disputer, or reject both.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "release" | "reject" | "keep_existing" | "award_disputer" | "reject_both"
note: string or null

Response · 200

datarequired: CoBrokeDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "side": "requester",
    "status": "requested",
    "share_id": "cmusrceel0000q7kaafxqi1om",
    "share": {
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "live": true
    },
    "partner": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "message": "string",
    "terms": {
      "basis": "pooled",
      "requester_share_bps": 0,
      "note": "string",
      "version": 0,
      "proposed_by": "requester",
      "requester_accepted_at": "2026-10-06T05:30:00.000Z",
      "owner_accepted_at": "2026-10-06T05:30:00.000Z"
    },
    "agreed_at": "2026-10-06T05:30:00.000Z",
    "my_deal_id": "cmusrceel0000q7kaafxqi1om",
    "closed_at": "2026-10-06T05:30:00.000Z",
    "close_note": "string",
    "dispute": {
      "opened_at": "2026-10-06T05:30:00.000Z",
      "opened_by": "requester",
      "reason": "string",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "resolution": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "last_activity_at": "2026-10-06T05:30:00.000Z",
    "esign": {
      "status": "none",
      "requested_by": "me",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "messages": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "message",
        "mine": true,
        "author_name": "string",
        "body": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "filename": "string",
        "content_type": "string",
        "size": 0,
        "mine": true,
        "uploaded_by_name": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "scan_status": "string"
      }
    ],
    "registrations": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "client_label": "string",
        "status": "active",
        "mine": true,
        "registered_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "disputes_id": "cmusrceel0000q7kaafxqi1om",
        "dispute_reason": "string",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decided_note": "string"
      }
    ],
    "partner_contact": {
      "phone": "string",
      "email": "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/network/shares

What the company shares

Live (active / paused) by default; `status=all` includes expired, revoked and closed shares.

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

Parameters

statusquery: "live" | "all"
kindquery: "listing" | "requirement"

Response · 200

datarequired: array of NetworkShare
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "listing",
      "title": "string",
      "deal_side": "sale",
      "category": "string",
      "property_types": [
        "string"
      ],
      "bhk": [
        0
      ],
      "city": "string",
      "localities": [
        "string"
      ],
      "price_min": 850000000,
      "price_max": 850000000,
      "area_min_sqft": 0,
      "area_max_sqft": 0,
      "verified": true,
      "summary": {
        "furnishing": [
          "string"
        ],
        "possession": "string",
        "available_from": "string"
      },
      "co_broke_terms": "string",
      "offered_split_bps": 0,
      "visibility": "circle",
      "circle": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "status": "active",
      "freshness": "fresh",
      "last_confirmed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "mine": true,
      "broker": {
        "profile_id": "cmusrceel0000q7kaafxqi1om",
        "display_name": "string",
        "city": "string",
        "rera_badge": "verified",
        "kyc_verified": true,
        "trust_level": "new"
      },
      "source": {
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "lead_id": "cmusrceel0000q7kaafxqi1om",
        "ref": "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/network/shares

Share a listing or a requirement (masked)

Shares a masked copy: price band, area range, locality and city — never the owner, the client, the unit or the address. A listing needs co-broking allowed; a requirement needs a buy / rent lead.

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

Request body

kindrequired: "listing" | "requirement"
property_id: Id or null
Opaque record id.
lead_id: Id or null
Opaque record id.
visibilityrequired: "circle" | "network"
circle_id: Id or null
Opaque record id.
co_broke_terms: string or null
offered_split_bps: integer or null

Response · 201

datarequired: NetworkShare
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/shares' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"listing","property_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","visibility":"circle","circle_id":"cmusrceel0000q7kaafxqi1om","co_broke_terms":"string","offered_split_bps":50}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "title": "string",
    "deal_side": "sale",
    "category": "string",
    "property_types": [
      "string"
    ],
    "bhk": [
      0
    ],
    "city": "string",
    "localities": [
      "string"
    ],
    "price_min": 850000000,
    "price_max": 850000000,
    "area_min_sqft": 0,
    "area_max_sqft": 0,
    "verified": true,
    "summary": {
      "furnishing": [
        "string"
      ],
      "possession": "string",
      "available_from": "string"
    },
    "co_broke_terms": "string",
    "offered_split_bps": 0,
    "visibility": "circle",
    "circle": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "status": "active",
    "freshness": "fresh",
    "last_confirmed_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "mine": true,
    "broker": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "source": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    }
  },
  "meta": {}
}

Errors

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

POST/v1/network/shares/{id}/availability

Ask whether a shared item is still available

One open ping per share; the sharer has 48 hours to answer.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 201

datarequired: NetworkAvailabilityCheck
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "direction": "inbound",
    "share": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "title": "string"
    },
    "status": "pending",
    "asked_at": "2026-10-06T05:30:00.000Z",
    "answered_at": "2026-10-06T05:30:00.000Z",
    "answer_note": "string",
    "broker": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    }
  },
  "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/network/shares/{id}/status

Confirm, pause, resume, revoke or close a share

`confirm`: still available (resets the 15-day clock, re-opens an expired share). `revoke` removes it from the network at once; open co-brokes keep their snapshot.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "confirm" | "pause" | "resume" | "revoke" | "close"

Response · 200

datarequired: NetworkShare
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/network/shares/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"confirm"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "title": "string",
    "deal_side": "sale",
    "category": "string",
    "property_types": [
      "string"
    ],
    "bhk": [
      0
    ],
    "city": "string",
    "localities": [
      "string"
    ],
    "price_min": 850000000,
    "price_max": 850000000,
    "area_min_sqft": 0,
    "area_max_sqft": 0,
    "verified": true,
    "summary": {
      "furnishing": [
        "string"
      ],
      "possession": "string",
      "available_from": "string"
    },
    "co_broke_terms": "string",
    "offered_split_bps": 0,
    "visibility": "circle",
    "circle": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "status": "active",
    "freshness": "fresh",
    "last_confirmed_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "mine": true,
    "broker": {
      "profile_id": "cmusrceel0000q7kaafxqi1om",
      "display_name": "string",
      "city": "string",
      "rera_badge": "verified",
      "kyc_verified": true,
      "trust_level": "new"
    },
    "source": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "lead_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "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/network/suggestions

Network shares for your unshared leads and listings

Other companies’ live shares that fit the company’s own open buyer / tenant leads and active listings that are not shared. Suggestions only: nothing is shared or sent; the other side is seen only as its masked share.

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

Response · 200

datarequired: array of NetworkSuggestion
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "score": 0,
      "reasons": [
        "locality"
      ],
      "mine": {
        "kind": "lead",
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string"
      },
      "theirs": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "listing",
        "title": "string",
        "deal_side": "sale",
        "category": "string",
        "property_types": [
          "string"
        ],
        "bhk": [
          0
        ],
        "city": "string",
        "localities": [
          "string"
        ],
        "price_min": 850000000,
        "price_max": 850000000,
        "area_min_sqft": 0,
        "area_max_sqft": 0,
        "verified": true,
        "summary": {
          "furnishing": [
            "string"
          ],
          "possession": "string",
          "available_from": "string"
        },
        "co_broke_terms": "string",
        "offered_split_bps": 0,
        "visibility": "circle",
        "circle": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "status": "active",
        "freshness": "fresh",
        "last_confirmed_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "mine": true,
        "broker": {
          "profile_id": "cmusrceel0000q7kaafxqi1om",
          "display_name": "string",
          "city": "string",
          "rera_badge": "verified",
          "kyc_verified": true,
          "trust_level": "new"
        },
        "source": {
          "property_id": "cmusrceel0000q7kaafxqi1om",
          "lead_id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string"
        }
      }
    }
  ],
  "meta": {}
}

Errors

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