Integrations

Connector catalogue, connections and their health, Meta Lead Ads and Google Ads lead forms.

GET/v1/integrations

Connector catalogue and connections

Every connector by category (built and planned) with the workspace’s connections and their health.

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

Response · 200

datarequired: IntegrationsOverview
metarequired: object

Request

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

Response example

{
  "data": {
    "categories": [
      {
        "key": "string",
        "label": "string",
        "connectors": [
          {
            "key": "string",
            "provider": "string",
            "name": "string",
            "category": "string",
            "description": "string",
            "auth_kind": "oauth",
            "capabilities": [
              null
            ],
            "status": "ga",
            "logo": "string",
            "docs": {
              "summary": null,
              "readme": null,
              "url": null
            },
            "available": true,
            "connect_modes": [
              null
            ],
            "notice": "string",
            "multiple": true,
            "task": "string",
            "connections": [
              null
            ]
          }
        ]
      }
    ]
  },
  "meta": {}
}

Errors

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

POST/v1/integrations/connections

Connect an integration

For connectors without OAuth. Google Ads lead forms: returns the webhook URL (`connection.inbound_url`) and the `google_key` (in `revealed_secrets`, shown once). Meta connects through the OAuth endpoints or `/meta/own-app`.

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

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

connectorrequired: string
Connector key, e.g. google.ads_lead_forms.
name: string or null

Response · 201

datarequired: IntegrationConnectionCreated
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/connections' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"connector":"string","name":"string"}'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "string",
      "connector_key": "string",
      "name": "string",
      "status": "pending",
      "health": "ok",
      "config": {},
      "has_secret": true,
      "secret_hints": {},
      "inbound_url": "string",
      "scopes": [
        "string"
      ],
      "connected_at": "2026-10-06T05:30:00.000Z",
      "connected_by_id": "cmusrceel0000q7kaafxqi1om",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "error_count": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "revealed_secrets": {}
  },
  "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/integrations/connections/{id}

An integration connection

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
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/integrations/connections/{id}

Rename an integration connection or change its default source

Google Ads lead forms also take `allowed_ips`: the IPv4 / IPv6 addresses or CIDR blocks that may call the webhook URL (empty = any caller); other callers get 403.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string or null
default_source_id: Id or null
Opaque record id.
allowed_ips: array of string

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/integrations/connections/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","default_source_id":"cmusrceel0000q7kaafxqi1om","allowed_ips":["string"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

DELETE/v1/integrations/connections/{id}

Disconnect an integration

Wipes its secrets and routing; the connection stays for history and can be connected again.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
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.

PUT/v1/integrations/connections/{id}/google/forms/{formId}

Configure a Google Ads lead form

Routes one form to its own lead source with its project, lead type, field mapping and consent questions (column id → consent ledger).

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

Parameters

idpathrequired: Id
Opaque record id.
formIdpathrequired: string

Request body

name: string or null
source_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
lead_type: LeadType or null
mapping: FieldMapping
Incoming key (dotted for nested JSON / XML, matched case-insensitively) → PropZolo field.
consents: array of LeadFormConsentMappingInput

Response · 200

datarequired: GoogleFormConfig
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/integrations/connections/{id}/google/forms/{formId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","source_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","lead_type":"buy","mapping":{"SenderMobile":"phone","QueryInfo":"message","lead.budget":"budget","remarks":"ignore"},"consents":[{"key":"string","channels":["whatsapp"],"purpose":"promotional","text":"string","text_version":null}]}'

Response example

{
  "data": {
    "name": "string",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_type": "buy",
    "mapping": {},
    "consents": []
  },
  "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/integrations/connections/{id}/meta/forms

Lead forms of the connected Pages

Forms per Page (from Meta) with their saved configuration and mapping suggestions per question.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.pagesrequired: array of object
data.pages[].idrequired: string
data.pages[].namerequired: string
data.pages[].subscribedrequired: boolean
data.pages[].conflictrequired: boolean
data.pages[].errorrequired: string or null
data.pages[].formsrequired: array of object
metarequired: object

Request

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

Response example

{
  "data": {
    "pages": [
      {
        "id": "string",
        "name": "string",
        "subscribed": true,
        "conflict": true,
        "error": "string",
        "forms": [
          {
            "id": "string",
            "name": "string",
            "status": "string",
            "questions": [
              null
            ],
            "config": {
              "page_id": null,
              "name": null,
              "source_id": null,
              "project_id": null,
              "lead_type": null,
              "mapping": null,
              "consents": null,
              "enabled": null,
              "watermark": null
            }
          }
        ]
      }
    ]
  },
  "meta": {}
}

Errors

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

PUT/v1/integrations/connections/{id}/meta/forms/{formId}

Configure a Meta lead form

Lead source, project, lead type, field mapping, consent checkboxes (custom disclaimer → consent ledger) and on/off for one form.

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

Parameters

idpathrequired: Id
Opaque record id.
formIdpathrequired: string

Request body

page_idrequired: string
name: string or null
source_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
lead_type: LeadType or null
mapping: FieldMapping
Incoming key (dotted for nested JSON / XML, matched case-insensitively) → PropZolo field.
consents: array of LeadFormConsentMappingInput
enabled: boolean

Response · 200

datarequired: MetaFormConfig
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/integrations/connections/{id}/meta/forms/{formId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"page_id":"string","name":"string","source_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","lead_type":"buy","mapping":{"SenderMobile":"phone","QueryInfo":"message","lead.budget":"budget","remarks":"ignore"},"consents":[{"key":"string","channels":["whatsapp"],"purpose":"promotional","text":"string","text_version":null}],"enabled":true}'

Response example

{
  "data": {
    "page_id": "string",
    "name": "string",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "lead_type": "buy",
    "mapping": {},
    "consents": [],
    "enabled": true,
    "watermark": "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/integrations/connections/{id}/rotate

Rotate a generated secret

Google Ads: issues a new google_key (shown once); the old key stops working at once.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: IntegrationConnectionCreated
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/connections/{id}/rotate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "string",
      "connector_key": "string",
      "name": "string",
      "status": "pending",
      "health": "ok",
      "config": {},
      "has_secret": true,
      "secret_hints": {},
      "inbound_url": "string",
      "scopes": [
        "string"
      ],
      "connected_at": "2026-10-06T05:30:00.000Z",
      "connected_by_id": "cmusrceel0000q7kaafxqi1om",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "error_count": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "revealed_secrets": {}
  },
  "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/integrations/connections/{id}/test

Test an integration connection

Checks the credentials with the provider and records the result on the connection.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.okrequired: boolean
data.messagerequired: string
data.checked_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/integrations/connections/{id}/test' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "ok": true,
    "message": "string",
    "checked_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/integrations/health

Integration health

Every connection, automatic lead source and messaging channel with its state (ok, degraded, broken, silent, paused, setup), last success and error, 24 h / 7 d volume, held webhook items, token expiry and portal package end, most urgent first, each with one fix link. Read-only; `filter=attention` keeps the rows that are not ok.

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

Parameters

filterquery: "all" | "attention"

Response · 200

datarequired: array of IntegrationHealthRow
metarequired: object
meta.totalrequired: integer
meta.attentionrequired: integer
meta.generated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Request

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

Response example

{
  "data": [
    {
      "key": "string",
      "kind": "connection",
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "provider": "string",
      "category": "string",
      "status": "broken",
      "summary": "string",
      "issues": [
        "string"
      ],
      "last_success_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "volume_24h": 0,
      "volume_7d": 0,
      "errors_24h": 0,
      "error_rate_24h": 0,
      "parked_count": 0,
      "parked_oldest_at": "2026-10-06T05:30:00.000Z",
      "token_expires_at": "2026-10-06T05:30:00.000Z",
      "package_ends_on": "string",
      "action": {
        "kind": "reconnect",
        "label": "string",
        "href": "string"
      }
    }
  ],
  "meta": {
    "total": 0,
    "attention": 0,
    "generated_at": "2026-10-06T05:30:00.000Z"
  }
}

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/integrations/meta/oauth/callback

Facebook Login callback

Exchanges the code for a long-lived token, subscribes the granted Pages to leadgen, stores the connection and redirects to Settings → Integrations → Meta (`?connected=<id>` or `?error=<reason>`).

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

Parameters

codequery: string
statequery: string
errorquery: string
error_reasonquery: string

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/integrations/meta/oauth/callback' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{}

Errors

302 Back to Settings → Integrations → Meta.
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/integrations/meta/oauth/start

Start connecting Meta Lead Ads

The Facebook Login for Business URL (state bound to the signed-in member, valid 10 minutes). With `redirect=true` the browser is redirected there directly. 404 until PropZolo’s Meta app is configured in the super-admin console (own-app mode works without it).

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

Parameters

redirectquery: string

Response · 200

datarequired: object
data.urlrequired: string
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/integrations/meta/oauth/start' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string"
  },
  "meta": {}
}

Errors

302 Redirect to Facebook (redirect=true).
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/integrations/meta/own-app

Connect Meta Lead Ads with your own Meta app

Own-app mode, no PropZolo Meta app needed: checks the token with your app (debug_token), subscribes your app to each Page’s leadgen field and stores the connection (secrets in the vault). Point your app’s Page webhook at `revealed_secrets.callback_url` with `revealed_secrets.verify_token` (shown once). Connecting the same app again refreshes its connection.

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

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

app_idrequired: string
app_secretrequired: string
access_tokenrequired: string
A system-user token of your business (recommended — it does not expire) or a Page token.
verify_token: string or null
Webhook verify token; generated when omitted.
name: string or null

Response · 201

datarequired: IntegrationConnectionCreated
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/meta/own-app' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"app_id":"string","app_secret":"string","access_token":"string","verify_token":"string","name":"string"}'

Response example

{
  "data": {
    "connection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "string",
      "connector_key": "string",
      "name": "string",
      "status": "pending",
      "health": "ok",
      "config": {},
      "has_secret": true,
      "secret_hints": {},
      "inbound_url": "string",
      "scopes": [
        "string"
      ],
      "connected_at": "2026-10-06T05:30:00.000Z",
      "connected_by_id": "cmusrceel0000q7kaafxqi1om",
      "last_ok_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "error_count": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "revealed_secrets": {}
  },
  "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/integrations/parked-items

Held webhook items

Provider webhook items that could not be applied yet (an unknown number, a status before its message, a file Meta did not hand over), newest first. Retried automatically; `meta.parked_count` counts the waiting ones.

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

Parameters

statusquery: "parked" | "replayed" | "discarded"
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of ParkedWebhookItem
metarequired: object
meta.next_cursorrequired: string or null
meta.has_morerequired: boolean
meta.parked_countrequired: integer

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "provider": "string",
      "kind": "string",
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "summary": "string",
      "reason": "string",
      "attempts": 0,
      "max_attempts": 0,
      "status": "parked",
      "next_attempt_at": "2026-10-06T05:30:00.000Z",
      "last_attempt_at": "2026-10-06T05:30:00.000Z",
      "resolved_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true,
    "parked_count": 0
  }
}

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/integrations/parked-items/{id}/discard

Discard a held webhook item

Stops the automatic tries of a waiting item; it can still be replayed later.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ParkedWebhookItem
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/parked-items/{id}/discard' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "kind": "string",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "summary": "string",
    "reason": "string",
    "attempts": 0,
    "max_attempts": 0,
    "status": "parked",
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "last_attempt_at": "2026-10-06T05:30:00.000Z",
    "resolved_at": "2026-10-06T05:30:00.000Z",
    "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.

POST/v1/integrations/parked-items/{id}/replay

Replay a held webhook item

Queues the item for a new try within a minute, with a fresh retry schedule.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 202

datarequired: ParkedWebhookItem
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/parked-items/{id}/replay' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "kind": "string",
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "summary": "string",
    "reason": "string",
    "attempts": 0,
    "max_attempts": 0,
    "status": "parked",
    "next_attempt_at": "2026-10-06T05:30:00.000Z",
    "last_attempt_at": "2026-10-06T05:30:00.000Z",
    "resolved_at": "2026-10-06T05:30:00.000Z",
    "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.

POST/v1/integrations/payments

Connect Razorpay or Cashfree

Razorpay: key id, key secret and the webhook secret you set in the Razorpay dashboard (add the returned `inbound_url` there with the payment_link events). Cashfree: app id and secret key (production or sandbox).

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

Request body

providerrequired: "razorpay" | "cashfree"
name: string or null
key_id: string
key_secret: string
webhook_secret: string
client_id: string
client_secret: string
environment: "production" | "sandbox"

Response · 201

datarequired: IntegrationConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/payments' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"provider":"razorpay","name":"string","key_id":"string","key_secret":"string","webhook_secret":"string","client_id":"string","client_secret":"string","environment":"production"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
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/integrations/payments/{id}

Change a payment gateway’s keys or name

Only the keys sent are replaced.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string or null
key_id: string
key_secret: string
webhook_secret: string
client_id: string
client_secret: string
environment: "production" | "sandbox"

Response · 200

datarequired: IntegrationConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/integrations/payments/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","key_id":"string","key_secret":"string","webhook_secret":"string","client_id":"string","client_secret":"string","environment":"production"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "provider": "string",
    "connector_key": "string",
    "name": "string",
    "status": "pending",
    "health": "ok",
    "config": {},
    "has_secret": true,
    "secret_hints": {},
    "inbound_url": "string",
    "scopes": [
      "string"
    ],
    "connected_at": "2026-10-06T05:30:00.000Z",
    "connected_by_id": "cmusrceel0000q7kaafxqi1om",
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

POST/v1/integrations/payments/{id}/test

Test a payment gateway connection

Probes the keys with the provider and records the result on the connection.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.okrequired: boolean
data.messagerequired: string
data.checked_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.webhook_urlrequired: string or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/payments/{id}/test' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "ok": true,
    "message": "string",
    "checked_at": "2026-10-06T05:30:00.000Z",
    "webhook_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.

GET/v1/integrations/portals/{portal}

A portal’s onboarding guide and connections

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

Parameters

portalpathrequired: PortalKey

Response · 200

datarequired: PortalSetup
metarequired: object

Request

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

Response example

{
  "data": {
    "portal": "99acres",
    "name": "string",
    "modes": [
      "push"
    ],
    "push_contact": "string",
    "push_method": "string",
    "push_steps": [
      "string"
    ],
    "pull_steps": [
      "string"
    ],
    "pull_credentials": [
      {
        "name": "string",
        "label": "string",
        "help": "string",
        "secret": true
      }
    ],
    "email_steps": [
      "string"
    ],
    "caveat": "string",
    "can_manage": true,
    "connections": [
      {
        "connection_id": "cmusrceel0000q7kaafxqi1om",
        "portal": "99acres",
        "name": "string",
        "status": "string",
        "health": "ok",
        "source_id": "cmusrceel0000q7kaafxqi1om",
        "push_url": "string",
        "pull": {
          "enabled": true,
          "interval_minutes": 0,
          "overlap_minutes": 0,
          "endpoint": "string"
        },
        "sync": {
          "cursor": "string",
          "last_run_at": "string",
          "last_status": "ok",
          "last_count": 0,
          "last_error": "string",
          "reconcile": {
            "last_at": "string",
            "last_on": "string",
            "status": "ok",
            "stored": 0,
            "error": "string"
          }
        },
        "credentials": {
          "has_secret": true,
          "fields": [
            "string"
          ],
          "hints": {}
        },
        "activation": {
          "status": "not_requested",
          "requested_at": "string",
          "requested_by": "string",
          "waiting_at": "string",
          "test_lead_at": "string",
          "live_at": "string",
          "reminded_at": "string"
        },
        "project_map": [
          {
            "portal_project_id": "string",
            "project_id": "cmusrceel0000q7kaafxqi1om"
          }
        ],
        "package_ends_on": "2026-10-06",
        "allowed_ips": [
          "string"
        ],
        "last_ok_at": "2026-10-06T05:30:00.000Z",
        "last_error": "string",
        "error_count": 0,
        "created_at": "2026-10-06T05:30:00.000Z",
        "onboarding": {
          "email_subject": "string",
          "email_body": "string",
          "mailto": "string",
          "test_url": "string"
        }
      }
    ],
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "is_active": 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/integrations/portals/{portal}

Connect a portal account

Creates the push URL and binds a lead source (the given one, the portal’s source, or a new one).

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

Parameters

portalpathrequired: "99acres" | "magicbricks" | "housing" | "justdial" | "sulekha" | "commonfloor"
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

source_id: Id or null
Opaque record id.
name: string or null

Response · 201

datarequired: PortalConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/portals/{portal}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"source_id":"cmusrceel0000q7kaafxqi1om","name":"string"}'

Response example

{
  "data": {
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "portal": "99acres",
    "name": "string",
    "status": "string",
    "health": "ok",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "push_url": "string",
    "pull": {
      "enabled": true,
      "interval_minutes": 0,
      "overlap_minutes": 0,
      "endpoint": "string"
    },
    "sync": {
      "cursor": "string",
      "last_run_at": "string",
      "last_status": "ok",
      "last_count": 0,
      "last_error": "string",
      "reconcile": {
        "last_at": "string",
        "last_on": "string",
        "status": "ok",
        "stored": 0,
        "error": "string"
      }
    },
    "credentials": {
      "has_secret": true,
      "fields": [
        "string"
      ],
      "hints": {}
    },
    "activation": {
      "status": "not_requested",
      "requested_at": "string",
      "requested_by": "string",
      "waiting_at": "string",
      "test_lead_at": "string",
      "live_at": "string",
      "reminded_at": "string"
    },
    "project_map": [
      {
        "portal_project_id": "string",
        "project_id": "cmusrceel0000q7kaafxqi1om"
      }
    ],
    "package_ends_on": "2026-10-06",
    "allowed_ips": [
      "string"
    ],
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "onboarding": {
      "email_subject": "string",
      "email_body": "string",
      "mailto": "string",
      "test_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.
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/integrations/portals/{portal}/{id}

Change a portal connection: source, pull settings, pull credentials, activation, project map, package end

Credentials are write-only: a value replaces, null removes, an absent key keeps the stored one.

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

Parameters

portalpathrequired: "99acres" | "magicbricks" | "housing" | "justdial" | "sulekha" | "commonfloor"
idpathrequired: Id
Opaque record id.

Request body

name: string or null
source_id: Id
Opaque record id.
pull: object
pull.enabled: boolean
pull.interval_minutes: integer
pull.overlap_minutes: integer
pull.endpoint: string (uri) or null
secrets: map of string or null
activation: "requested" | "waiting_for_portal"
project_map: array of object
project_map[].portal_project_idrequired: string
project_map[].project_idrequired: Id
Opaque record id.
package_ends_on: string (date) or null
allowed_ips: array of string

Response · 200

datarequired: PortalConnection
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/integrations/portals/{portal}/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","source_id":"cmusrceel0000q7kaafxqi1om","pull":{"enabled":true,"interval_minutes":5,"overlap_minutes":0,"endpoint":"https://example.com"},"secrets":{},"activation":"requested","project_map":[{"portal_project_id":"string","project_id":"cmusrceel0000q7kaafxqi1om"}],"package_ends_on":"2026-10-06","allowed_ips":["string"]}'

Response example

{
  "data": {
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "portal": "99acres",
    "name": "string",
    "status": "string",
    "health": "ok",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "push_url": "string",
    "pull": {
      "enabled": true,
      "interval_minutes": 0,
      "overlap_minutes": 0,
      "endpoint": "string"
    },
    "sync": {
      "cursor": "string",
      "last_run_at": "string",
      "last_status": "ok",
      "last_count": 0,
      "last_error": "string",
      "reconcile": {
        "last_at": "string",
        "last_on": "string",
        "status": "ok",
        "stored": 0,
        "error": "string"
      }
    },
    "credentials": {
      "has_secret": true,
      "fields": [
        "string"
      ],
      "hints": {}
    },
    "activation": {
      "status": "not_requested",
      "requested_at": "string",
      "requested_by": "string",
      "waiting_at": "string",
      "test_lead_at": "string",
      "live_at": "string",
      "reminded_at": "string"
    },
    "project_map": [
      {
        "portal_project_id": "string",
        "project_id": "cmusrceel0000q7kaafxqi1om"
      }
    ],
    "package_ends_on": "2026-10-06",
    "allowed_ips": [
      "string"
    ],
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "onboarding": {
      "email_subject": "string",
      "email_body": "string",
      "mailto": "string",
      "test_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.
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/integrations/portals/{portal}/{id}

Disconnect a portal account

The push URL stops working and stored credentials are wiped; received leads stay.

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

Parameters

portalpathrequired: "99acres" | "magicbricks" | "housing" | "justdial" | "sulekha" | "commonfloor"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.okrequired: true
metarequired: object

Request

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

Response example

{
  "data": {
    "ok": 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/integrations/portals/{portal}/{id}/rotate

Issue a new push URL

The old URL stops working at once — send the new one to the portal’s team.

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

Parameters

portalpathrequired: "99acres" | "magicbricks" | "housing" | "justdial" | "sulekha" | "commonfloor"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PortalConnection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/portals/{portal}/{id}/rotate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "connection_id": "cmusrceel0000q7kaafxqi1om",
    "portal": "99acres",
    "name": "string",
    "status": "string",
    "health": "ok",
    "source_id": "cmusrceel0000q7kaafxqi1om",
    "push_url": "string",
    "pull": {
      "enabled": true,
      "interval_minutes": 0,
      "overlap_minutes": 0,
      "endpoint": "string"
    },
    "sync": {
      "cursor": "string",
      "last_run_at": "string",
      "last_status": "ok",
      "last_count": 0,
      "last_error": "string",
      "reconcile": {
        "last_at": "string",
        "last_on": "string",
        "status": "ok",
        "stored": 0,
        "error": "string"
      }
    },
    "credentials": {
      "has_secret": true,
      "fields": [
        "string"
      ],
      "hints": {}
    },
    "activation": {
      "status": "not_requested",
      "requested_at": "string",
      "requested_by": "string",
      "waiting_at": "string",
      "test_lead_at": "string",
      "live_at": "string",
      "reminded_at": "string"
    },
    "project_map": [
      {
        "portal_project_id": "string",
        "project_id": "cmusrceel0000q7kaafxqi1om"
      }
    ],
    "package_ends_on": "2026-10-06",
    "allowed_ips": [
      "string"
    ],
    "last_ok_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "error_count": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "onboarding": {
      "email_subject": "string",
      "email_body": "string",
      "mailto": "string",
      "test_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/integrations/portals/{portal}/{id}/test

Test a portal pull

Asks the portal for the last 24 hours with the stored credentials; nothing is stored.

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

Parameters

portalpathrequired: "99acres" | "magicbricks" | "housing" | "justdial" | "sulekha" | "commonfloor"
idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.okrequired: boolean
data.fetchedrequired: integer
data.messagerequired: string
data.windowrequired: object
data.window.fromrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.window.torequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/integrations/portals/{portal}/{id}/test' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "ok": true,
    "fetched": 0,
    "message": "string",
    "window": {
      "from": "2026-10-06T05:30:00.000Z",
      "to": "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.