Approvals

Human approvals: workflow steps and approval chains of guarded actions (exports, deletes, discounts, rent below the floor, brokerage, stage gates) — levels, holds, bulk decisions, signed links, WhatsApp, the policies.

GET/v1/approvals

Approval requests for me

Requests the caller may decide — named, through their role, or through a permission they hold. `view`: pending (default), decided, all. Newest first; keyset pagination.

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
viewquery: "pending" | "decided" | "all"

Response · 200

datarequired: array of ApprovalRequest
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "status": "pending",
      "title": "string",
      "details": "string",
      "text": "string",
      "edited_text": "string",
      "allow_edit": true,
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "workflow": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "approvers": {
        "permission": "string",
        "role_keys": [
          "string"
        ],
        "member_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ]
      },
      "due_at": "2026-10-06T05:30:00.000Z",
      "overdue": true,
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "decision_channel": "string",
      "created_at": "2026-10-06T05:30:00.000Z",
      "can_decide": true,
      "chain": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "kind_label": "string",
        "status": "pending",
        "title": "string",
        "reason": "string",
        "summary": [
          {
            "label": "string",
            "value": "string"
          }
        ],
        "level": 0,
        "levels": [
          {
            "level": 0,
            "name": "string",
            "status": "string",
            "decided_by": {
              "id": null,
              "name": null
            },
            "decided_at": "2026-10-06T05:30:00.000Z",
            "decision_note": "string",
            "channel": "string",
            "hold_reason": "string",
            "escalated": true,
            "due_at": "2026-10-06T05:30:00.000Z"
          }
        ],
        "requested_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "request_note": "string",
        "action_status": "waiting",
        "action_error": "string",
        "applied_at": "2026-10-06T05:30:00.000Z",
        "entity": {
          "type": "string",
          "id": "cmusrceel0000q7kaafxqi1om"
        },
        "lead": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "decided_at": "2026-10-06T05:30:00.000Z",
        "can_cancel": true
      },
      "level": 0,
      "hold": {
        "reason": "string",
        "at": "2026-10-06T05:30:00.000Z",
        "by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      },
      "escalated": true,
      "history": [
        {
          "at": "string",
          "kind": "string",
          "by": "string",
          "note": "string",
          "channel": "string"
        }
      ]
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

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

POST/v1/approvals/bulk-decide

Approve or reject many requests

Each request the caller may decide, in order; the others are skipped with a reason (at most 100).

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

Request body

idsrequired: array of Id
Opaque record id.
decisionrequired: "approve" | "reject"
note: string or null

Response · 200

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

Request

curl -X POST 'https://api.propzolo.com/v1/approvals/bulk-decide' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"],"decision":"approve","note":"string"}'

Response example

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

Errors

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

An approval request by its signed link

For the approver the link was sent to (single-use, 7 days). 404 for an unknown link.

Access: No authentication.

Parameters

tokenpathrequired: string

Response · 200

datarequired: ApprovalTokenView
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/approvals/by-token/{token}'

Response example

{
  "data": {
    "state": "open",
    "title": "string",
    "reason": "string",
    "summary": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "requested_by": "string",
    "approver": "string",
    "level": {
      "number": 0,
      "of": 0,
      "name": "string"
    },
    "status": "string",
    "due_at": "2026-10-06T05:30:00.000Z",
    "decided_by": "string",
    "decided_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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/approvals/by-token/{token}/decide

Approve or reject by the signed link

Once: the first decision uses the link up; later calls change nothing and say why.

Access: No authentication.

Parameters

tokenpathrequired: string

Request body

decisionrequired: "approve" | "reject"
note: string or null

Response · 200

datarequired: object
data.outcomerequired: "decided" | "already_decided" | "used" | "expired" | "invalid" | "not_allowed" | …
data.statusrequired: string or null
data.titlerequired: string or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/approvals/by-token/{token}/decide' \
  -H 'Content-Type: application/json' \
  -d '{"decision":"approve","note":"string"}'

Response example

{
  "data": {
    "outcome": "decided",
    "status": "string",
    "title": "string"
  },
  "meta": {}
}

Errors

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/approvals/requests

Approvals I asked for

The caller’s own chains, newest first: where each stands and what became of its action.

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
statusquery: "open" | "settled" | "all"

Response · 200

datarequired: array of ApprovalChain
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "kind_label": "string",
      "status": "pending",
      "title": "string",
      "reason": "string",
      "summary": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "level": 0,
      "levels": [
        {
          "level": 0,
          "name": "string",
          "status": "string",
          "decided_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "channel": "string",
          "hold_reason": "string",
          "escalated": true,
          "due_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requested_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "request_note": "string",
      "action_status": "waiting",
      "action_error": "string",
      "applied_at": "2026-10-06T05:30:00.000Z",
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "can_cancel": true
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

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

GET/v1/approvals/requests/{id}

An approval chain

For its requester or an approver of one of its levels.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ApprovalChain
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "kind_label": "string",
    "status": "pending",
    "title": "string",
    "reason": "string",
    "summary": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "level": 0,
    "levels": [
      {
        "level": 0,
        "name": "string",
        "status": "string",
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "channel": "string",
        "hold_reason": "string",
        "escalated": true,
        "due_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requested_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "request_note": "string",
    "action_status": "waiting",
    "action_error": "string",
    "applied_at": "2026-10-06T05:30:00.000Z",
    "entity": {
      "type": "string",
      "id": "cmusrceel0000q7kaafxqi1om"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "can_cancel": 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/approvals/requests/{id}/cancel

Withdraw my request

Only while it waits; its action is dropped.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ApprovalChain
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/approvals/requests/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "kind_label": "string",
    "status": "pending",
    "title": "string",
    "reason": "string",
    "summary": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "level": 0,
    "levels": [
      {
        "level": 0,
        "name": "string",
        "status": "string",
        "decided_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "decided_at": "2026-10-06T05:30:00.000Z",
        "decision_note": "string",
        "channel": "string",
        "hold_reason": "string",
        "escalated": true,
        "due_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requested_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "request_note": "string",
    "action_status": "waiting",
    "action_error": "string",
    "applied_at": "2026-10-06T05:30:00.000Z",
    "entity": {
      "type": "string",
      "id": "cmusrceel0000q7kaafxqi1om"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "can_cancel": true
  },
  "meta": {}
}

Errors

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

GET/v1/approvals/whatsapp

My approval requests on WhatsApp

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

Response · 200

datarequired: ApprovalWhatsappOptIn
metarequired: object

Request

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

Response example

{
  "data": {
    "enabled": true,
    "company_enabled": true,
    "phone": "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.

PUT/v1/approvals/whatsapp

Get approval requests on WhatsApp

Sent from PropZolo’s number to the member’s verified phone, with Approve / Reject buttons.

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

Request body

enabledrequired: boolean

Response · 200

datarequired: ApprovalWhatsappOptIn
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/approvals/whatsapp' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true}'

Response example

{
  "data": {
    "enabled": true,
    "company_enabled": true,
    "phone": "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/approvals/{id}

An approval request

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ApprovalRequest
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "status": "pending",
    "title": "string",
    "details": "string",
    "text": "string",
    "edited_text": "string",
    "allow_edit": true,
    "entity": {
      "type": "string",
      "id": "cmusrceel0000q7kaafxqi1om"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "workflow": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "approvers": {
      "permission": "string",
      "role_keys": [
        "string"
      ],
      "member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ]
    },
    "due_at": "2026-10-06T05:30:00.000Z",
    "overdue": true,
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "decision_channel": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_decide": true,
    "chain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "kind_label": "string",
      "status": "pending",
      "title": "string",
      "reason": "string",
      "summary": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "level": 0,
      "levels": [
        {
          "level": 0,
          "name": "string",
          "status": "string",
          "decided_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "channel": "string",
          "hold_reason": "string",
          "escalated": true,
          "due_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requested_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "request_note": "string",
      "action_status": "waiting",
      "action_error": "string",
      "applied_at": "2026-10-06T05:30:00.000Z",
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "can_cancel": true
    },
    "level": 0,
    "hold": {
      "reason": "string",
      "at": "2026-10-06T05:30:00.000Z",
      "by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "escalated": true,
    "history": [
      {
        "at": "string",
        "kind": "string",
        "by": "string",
        "note": "string",
        "channel": "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/approvals/{id}/decide

Approve, approve with edits or reject

Once per request, before its SLA. A waiting workflow continues on the decision’s branch (with the edited text on "edit").

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

decisionrequired: "approve" | "edit" | "reject"
note: string or null
edited_text: string or null
channel: "web" | "push"
push: decided from a notification on the phone (recorded on the decision).

Response · 200

datarequired: ApprovalRequest
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/approvals/{id}/decide' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"decision":"approve","note":"string","edited_text":"string","channel":"web"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "status": "pending",
    "title": "string",
    "details": "string",
    "text": "string",
    "edited_text": "string",
    "allow_edit": true,
    "entity": {
      "type": "string",
      "id": "cmusrceel0000q7kaafxqi1om"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "workflow": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "approvers": {
      "permission": "string",
      "role_keys": [
        "string"
      ],
      "member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ]
    },
    "due_at": "2026-10-06T05:30:00.000Z",
    "overdue": true,
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "decision_channel": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_decide": true,
    "chain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "kind_label": "string",
      "status": "pending",
      "title": "string",
      "reason": "string",
      "summary": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "level": 0,
      "levels": [
        {
          "level": 0,
          "name": "string",
          "status": "string",
          "decided_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "channel": "string",
          "hold_reason": "string",
          "escalated": true,
          "due_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requested_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "request_note": "string",
      "action_status": "waiting",
      "action_error": "string",
      "applied_at": "2026-10-06T05:30:00.000Z",
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "can_cancel": true
    },
    "level": 0,
    "hold": {
      "reason": "string",
      "at": "2026-10-06T05:30:00.000Z",
      "by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "escalated": true,
    "history": [
      {
        "at": "string",
        "kind": "string",
        "by": "string",
        "note": "string",
        "channel": "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/approvals/{id}/hold

Put a request on hold

A chain level only, with the reason: its time stops until it is resumed (or decided).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: ApprovalRequest
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/approvals/{id}/hold' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "status": "pending",
    "title": "string",
    "details": "string",
    "text": "string",
    "edited_text": "string",
    "allow_edit": true,
    "entity": {
      "type": "string",
      "id": "cmusrceel0000q7kaafxqi1om"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "workflow": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "approvers": {
      "permission": "string",
      "role_keys": [
        "string"
      ],
      "member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ]
    },
    "due_at": "2026-10-06T05:30:00.000Z",
    "overdue": true,
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "decision_channel": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_decide": true,
    "chain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "kind_label": "string",
      "status": "pending",
      "title": "string",
      "reason": "string",
      "summary": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "level": 0,
      "levels": [
        {
          "level": 0,
          "name": "string",
          "status": "string",
          "decided_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "channel": "string",
          "hold_reason": "string",
          "escalated": true,
          "due_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requested_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "request_note": "string",
      "action_status": "waiting",
      "action_error": "string",
      "applied_at": "2026-10-06T05:30:00.000Z",
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "can_cancel": true
    },
    "level": 0,
    "hold": {
      "reason": "string",
      "at": "2026-10-06T05:30:00.000Z",
      "by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "escalated": true,
    "history": [
      {
        "at": "string",
        "kind": "string",
        "by": "string",
        "note": "string",
        "channel": "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/approvals/{id}/resume

Resume a request on hold

The level gets back the time it had left when it was put on hold.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ApprovalRequest
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "string",
    "status": "pending",
    "title": "string",
    "details": "string",
    "text": "string",
    "edited_text": "string",
    "allow_edit": true,
    "entity": {
      "type": "string",
      "id": "cmusrceel0000q7kaafxqi1om"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "workflow": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "approvers": {
      "permission": "string",
      "role_keys": [
        "string"
      ],
      "member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ]
    },
    "due_at": "2026-10-06T05:30:00.000Z",
    "overdue": true,
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "decision_channel": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "can_decide": true,
    "chain": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "string",
      "kind_label": "string",
      "status": "pending",
      "title": "string",
      "reason": "string",
      "summary": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "level": 0,
      "levels": [
        {
          "level": 0,
          "name": "string",
          "status": "string",
          "decided_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "decided_at": "2026-10-06T05:30:00.000Z",
          "decision_note": "string",
          "channel": "string",
          "hold_reason": "string",
          "escalated": true,
          "due_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requested_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "request_note": "string",
      "action_status": "waiting",
      "action_error": "string",
      "applied_at": "2026-10-06T05:30:00.000Z",
      "entity": {
        "type": "string",
        "id": "cmusrceel0000q7kaafxqi1om"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "can_cancel": true
    },
    "level": 0,
    "hold": {
      "reason": "string",
      "at": "2026-10-06T05:30:00.000Z",
      "by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "escalated": true,
    "history": [
      {
        "at": "string",
        "kind": "string",
        "by": "string",
        "note": "string",
        "channel": "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/settings/approval-policies

Approval policies

What waits for approval (exports, deletes, discounts, rent below the floor, brokerage, stage gates).

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

Response · 200

datarequired: ApprovalPolicySettings
metarequired: object

Request

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

Response example

{
  "data": {
    "whatsapp": true,
    "policies": [
      {
        "key": "export",
        "label": "string",
        "description": "string",
        "threshold_info": {
          "label": "string",
          "unit": "string",
          "default": 0
        },
        "enabled": true,
        "threshold": 0,
        "threshold_months": 0,
        "levels": [
          {
            "name": "string",
            "approvers": {
              "permission": null,
              "role_keys": null,
              "member_ids": null,
              "requester_manager": null
            },
            "due_minutes": 0,
            "escalate_to": {
              "permission": null,
              "role_keys": null,
              "member_ids": null,
              "requester_manager": null
            },
            "escalation_minutes": 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/settings/approval-policies

Change the approval policies

Levels name approvers by permission, role, member or the requester’s manager. Needs a fresh TOTP.

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

Request body

whatsapprequired: boolean
policiesrequired: map of object

Response · 200

datarequired: ApprovalPolicySettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/approval-policies' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"whatsapp":true,"policies":{}}'

Response example

{
  "data": {
    "whatsapp": true,
    "policies": [
      {
        "key": "export",
        "label": "string",
        "description": "string",
        "threshold_info": {
          "label": "string",
          "unit": "string",
          "default": 0
        },
        "enabled": true,
        "threshold": 0,
        "threshold_months": 0,
        "levels": [
          {
            "name": "string",
            "approvers": {
              "permission": null,
              "role_keys": null,
              "member_ids": null,
              "requester_manager": null
            },
            "due_minutes": 0,
            "escalate_to": {
              "permission": null,
              "role_keys": null,
              "member_ids": null,
              "requester_manager": null
            },
            "escalation_minutes": 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.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "status": "pending", "title": "string", "details": "string", "text": "string", "edited_text": "string", "allow_edit": true, "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "workflow": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "approvers": { "permission": "string", "role_keys": [ "string" ], "member_ids": [ "cmusrceel0000q7kaafxqi1om" ] }, "due_at": "2026-10-06T05:30:00.000Z", "overdue": true, "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "decision_channel": "string", "created_at": "2026-10-06T05:30:00.000Z", "can_decide": true, "chain": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "kind_label": "string", "status": "pending", "title": "string", "reason": "string", "summary": [ { "label": "string", "value": "string" } ], "level": 0, "levels": [ { "level": 0, "name": "string", "status": "string", "decided_by": { "id": null, "name": null }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "channel": "string", "hold_reason": "string", "escalated": true, "due_at": "2026-10-06T05:30:00.000Z" } ], "requested_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "request_note": "string", "action_status": "waiting", "action_error": "string", "applied_at": "2026-10-06T05:30:00.000Z", "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "decided_at": "2026-10-06T05:30:00.000Z", "can_cancel": true }, "level": 0, "hold": { "reason": "string", "at": "2026-10-06T05:30:00.000Z", "by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "escalated": true, "history": [ { "at": "string", "kind": "string", "by": "string", "note": "string", "channel": "string" } ] } ], "meta": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/approvals/bulk-decide' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"ids":["cmusrceel0000q7kaafxqi1om"],"decision":"approve","note":"string"}'

{ "data": { "state": "open", "title": "string", "reason": "string", "summary": [ { "label": "string", "value": "string" } ], "requested_by": "string", "approver": "string", "level": { "number": 0, "of": 0, "name": "string" }, "status": "string", "due_at": "2026-10-06T05:30:00.000Z", "decided_by": "string", "decided_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "kind_label": "string", "status": "pending", "title": "string", "reason": "string", "summary": [ { "label": "string", "value": "string" } ], "level": 0, "levels": [ { "level": 0, "name": "string", "status": "string", "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "channel": "string", "hold_reason": "string", "escalated": true, "due_at": "2026-10-06T05:30:00.000Z" } ], "requested_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "request_note": "string", "action_status": "waiting", "action_error": "string", "applied_at": "2026-10-06T05:30:00.000Z", "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "decided_at": "2026-10-06T05:30:00.000Z", "can_cancel": true } ], "meta": { "next_cursor": "string", "has_more": true } }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "kind_label": "string", "status": "pending", "title": "string", "reason": "string", "summary": [ { "label": "string", "value": "string" } ], "level": 0, "levels": [ { "level": 0, "name": "string", "status": "string", "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "channel": "string", "hold_reason": "string", "escalated": true, "due_at": "2026-10-06T05:30:00.000Z" } ], "requested_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "request_note": "string", "action_status": "waiting", "action_error": "string", "applied_at": "2026-10-06T05:30:00.000Z", "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "decided_at": "2026-10-06T05:30:00.000Z", "can_cancel": true }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "status": "pending", "title": "string", "details": "string", "text": "string", "edited_text": "string", "allow_edit": true, "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "workflow": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "approvers": { "permission": "string", "role_keys": [ "string" ], "member_ids": [ "cmusrceel0000q7kaafxqi1om" ] }, "due_at": "2026-10-06T05:30:00.000Z", "overdue": true, "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "decision_channel": "string", "created_at": "2026-10-06T05:30:00.000Z", "can_decide": true, "chain": { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "kind_label": "string", "status": "pending", "title": "string", "reason": "string", "summary": [ { "label": "string", "value": "string" } ], "level": 0, "levels": [ { "level": 0, "name": "string", "status": "string", "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "channel": "string", "hold_reason": "string", "escalated": true, "due_at": "2026-10-06T05:30:00.000Z" } ], "requested_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "request_note": "string", "action_status": "waiting", "action_error": "string", "applied_at": "2026-10-06T05:30:00.000Z", "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "decided_at": "2026-10-06T05:30:00.000Z", "can_cancel": true }, "level": 0, "hold": { "reason": "string", "at": "2026-10-06T05:30:00.000Z", "by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "escalated": true, "history": [ { "at": "string", "kind": "string", "by": "string", "note": "string", "channel": "string" } ] }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/approvals/{id}/decide' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"decision":"approve","note":"string","edited_text":"string","channel":"web"}'

{ "data": { "whatsapp": true, "policies": [ { "key": "export", "label": "string", "description": "string", "threshold_info": { "label": "string", "unit": "string", "default": 0 }, "enabled": true, "threshold": 0, "threshold_months": 0, "levels": [ { "name": "string", "approvers": { "permission": null, "role_keys": null, "member_ids": null, "requester_manager": null }, "due_minutes": 0, "escalate_to": { "permission": null, "role_keys": null, "member_ids": null, "requester_manager": null }, "escalation_minutes": 0 } ] } ] }, "meta": {} }