Walk-ins

Site-office kiosks (pairing, revoking, questions, branding), the walk-in policy (CP lock window, versioned consent notice) and the site-office queue with tokens, waiting times and site visits.

GET/v1/kiosks

Site-office kiosks

Enrolled tablets with their project, letter, status, last contact and today’s walk-ins.

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

Response · 200

datarequired: array of Kiosk
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "site_name": "string",
      "status": "pending",
      "token_prefix": "string",
      "token_hint": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "settings": {
        "welcome_title": "string",
        "welcome_text": "string",
        "accent": "string",
        "language": "en",
        "otp": "required",
        "ask_lead_type": true,
        "configurations": [
          "string"
        ],
        "budget_bands": [
          {
            "key": "string",
            "label": "string",
            "min": 0,
            "max": 0
          }
        ],
        "came_via": [
          "walk_in"
        ],
        "ask_email": true,
        "ask_notes": true,
        "notify_member_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "default_owner_id": "cmusrceel0000q7kaafxqi1om",
        "idle_reset_sec": 0
      },
      "notify_members": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      ],
      "default_owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "paired_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "app_version": "string",
      "revoked_at": "2026-10-06T05:30:00.000Z",
      "pairing_expires_at": "2026-10-06T05:30:00.000Z",
      "kiosk_url": "string",
      "walk_ins_today": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/kiosks

Creates the kiosk (pending until a tablet pairs) and its first one-time pairing code (30 minutes, shown once — so the request is not replayable). Owners and admins confirm their authenticator code first (step-up).

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

Request body

namerequired: string
site_namerequired: string
project_id: Id or null
Opaque record id.
source_id: Id or null
Opaque record id.
settings: object
settings.welcome_title: string or null
settings.welcome_text: string or null
settings.accent: string or null
settings.language: "en" | "hi" | "both"
settings.otp: "required" | "optional" | "off"
settings.ask_lead_type: boolean
settings.configurations: array of string
settings.budget_bands: array of object
settings.budget_bands[].keyrequired: string
settings.budget_bands[].label: string
settings.budget_bands[].min: integer or null
settings.budget_bands[].max: integer or null
settings.came_via: array of "walk_in" | "cp" | "ad" | "referral" | "other"
settings.ask_email: boolean
settings.ask_notes: boolean
settings.notify_member_ids: array of Id
Opaque record id.
settings.default_owner_id: Id or null
Opaque record id.
settings.idle_reset_sec: integer

Response · 201

datarequired: KioskEnrolment
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/kiosks' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","site_name":"string","project_id":"cmusrceel0000q7kaafxqi1om","source_id":"cmusrceel0000q7kaafxqi1om","settings":{"welcome_title":"string","welcome_text":"string","accent":"string","language":"en","otp":"required","ask_lead_type":true,"configurations":["string"],"budget_bands":[{"key":"string","label":"string","min":0,"max":0}],"came_via":["walk_in"],"ask_email":true,"ask_notes":true,"notify_member_ids":["cmusrceel0000q7kaafxqi1om"],"default_owner_id":"cmusrceel0000q7kaafxqi1om","idle_reset_sec":30}}'

Response example

{
  "data": {
    "kiosk": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "site_name": "string",
      "status": "pending",
      "token_prefix": "string",
      "token_hint": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "settings": {
        "welcome_title": "string",
        "welcome_text": "string",
        "accent": "string",
        "language": "en",
        "otp": "required",
        "ask_lead_type": true,
        "configurations": [
          "string"
        ],
        "budget_bands": [
          {
            "key": "string",
            "label": "string",
            "min": 0,
            "max": 0
          }
        ],
        "came_via": [
          "walk_in"
        ],
        "ask_email": true,
        "ask_notes": true,
        "notify_member_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "default_owner_id": "cmusrceel0000q7kaafxqi1om",
        "idle_reset_sec": 0
      },
      "notify_members": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      ],
      "default_owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "paired_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "app_version": "string",
      "revoked_at": "2026-10-06T05:30:00.000Z",
      "pairing_expires_at": "2026-10-06T05:30:00.000Z",
      "kiosk_url": "string",
      "walk_ins_today": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "pairing": {
      "code": "string",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "pair_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.
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/kiosks/policy

The walk-in policy

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

Response · 200

datarequired: WalkInPolicy
metarequired: object

Request

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

Response example

{
  "data": {
    "cp_lock_days": 0,
    "consent_text": "string",
    "consent_version": 0,
    "verify_later": true
  },
  "meta": {}
}

Errors

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

PUT/v1/kiosks/policy

Update the walk-in policy

A changed consent text is a new version; walk-ins keep the version they saw.

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

Request body

cp_lock_days: integer
consent_text: string
verify_later: boolean

Response · 200

datarequired: WalkInPolicy
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/kiosks/policy' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"cp_lock_days":7,"consent_text":"string","verify_later":true}'

Response example

{
  "data": {
    "cp_lock_days": 0,
    "consent_text": "string",
    "consent_version": 0,
    "verify_later": true
  },
  "meta": {}
}

Errors

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

GET/v1/kiosks/{id}

A kiosk

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Kiosk
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "site_name": "string",
    "status": "pending",
    "token_prefix": "string",
    "token_hint": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "settings": {
      "welcome_title": "string",
      "welcome_text": "string",
      "accent": "string",
      "language": "en",
      "otp": "required",
      "ask_lead_type": true,
      "configurations": [
        "string"
      ],
      "budget_bands": [
        {
          "key": "string",
          "label": "string",
          "min": 0,
          "max": 0
        }
      ],
      "came_via": [
        "walk_in"
      ],
      "ask_email": true,
      "ask_notes": true,
      "notify_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "default_owner_id": "cmusrceel0000q7kaafxqi1om",
      "idle_reset_sec": 0
    },
    "notify_members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "default_owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paired_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "app_version": "string",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "pairing_expires_at": "2026-10-06T05:30:00.000Z",
    "kiosk_url": "string",
    "walk_ins_today": 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/kiosks/{id}

Update a kiosk

Names, project lock, lead source, branding, questions and who is notified.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
site_name: string
project_id: Id or null
Opaque record id.
source_id: Id or null
Opaque record id.
settings: object
settings.welcome_title: string or null
settings.welcome_text: string or null
settings.accent: string or null
settings.language: "en" | "hi" | "both"
settings.otp: "required" | "optional" | "off"
settings.ask_lead_type: boolean
settings.configurations: array of string
settings.budget_bands: array of object
settings.budget_bands[].keyrequired: string
settings.budget_bands[].label: string
settings.budget_bands[].min: integer or null
settings.budget_bands[].max: integer or null
settings.came_via: array of "walk_in" | "cp" | "ad" | "referral" | "other"
settings.ask_email: boolean
settings.ask_notes: boolean
settings.notify_member_ids: array of Id
Opaque record id.
settings.default_owner_id: Id or null
Opaque record id.
settings.idle_reset_sec: integer

Response · 200

datarequired: Kiosk
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/kiosks/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","site_name":"string","project_id":"cmusrceel0000q7kaafxqi1om","source_id":"cmusrceel0000q7kaafxqi1om","settings":{"welcome_title":"string","welcome_text":"string","accent":"string","language":"en","otp":"required","ask_lead_type":true,"configurations":["string"],"budget_bands":[{"key":"string","label":"string","min":0,"max":0}],"came_via":["walk_in"],"ask_email":true,"ask_notes":true,"notify_member_ids":["cmusrceel0000q7kaafxqi1om"],"default_owner_id":"cmusrceel0000q7kaafxqi1om","idle_reset_sec":30}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "site_name": "string",
    "status": "pending",
    "token_prefix": "string",
    "token_hint": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "settings": {
      "welcome_title": "string",
      "welcome_text": "string",
      "accent": "string",
      "language": "en",
      "otp": "required",
      "ask_lead_type": true,
      "configurations": [
        "string"
      ],
      "budget_bands": [
        {
          "key": "string",
          "label": "string",
          "min": 0,
          "max": 0
        }
      ],
      "came_via": [
        "walk_in"
      ],
      "ask_email": true,
      "ask_notes": true,
      "notify_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "default_owner_id": "cmusrceel0000q7kaafxqi1om",
      "idle_reset_sec": 0
    },
    "notify_members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "default_owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paired_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "app_version": "string",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "pairing_expires_at": "2026-10-06T05:30:00.000Z",
    "kiosk_url": "string",
    "walk_ins_today": 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/kiosks/{id}/pairing

A new pairing code for a kiosk

For a replaced tablet or a reset browser; the paired tablet keeps working until another one pairs. Step-up for owners and admins.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: KioskEnrolment
metarequired: object

Request

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

Response example

{
  "data": {
    "kiosk": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "site_name": "string",
      "status": "pending",
      "token_prefix": "string",
      "token_hint": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "settings": {
        "welcome_title": "string",
        "welcome_text": "string",
        "accent": "string",
        "language": "en",
        "otp": "required",
        "ask_lead_type": true,
        "configurations": [
          "string"
        ],
        "budget_bands": [
          {
            "key": "string",
            "label": "string",
            "min": 0,
            "max": 0
          }
        ],
        "came_via": [
          "walk_in"
        ],
        "ask_email": true,
        "ask_notes": true,
        "notify_member_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "default_owner_id": "cmusrceel0000q7kaafxqi1om",
        "idle_reset_sec": 0
      },
      "notify_members": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      ],
      "default_owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "paired_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "app_version": "string",
      "revoked_at": "2026-10-06T05:30:00.000Z",
      "pairing_expires_at": "2026-10-06T05:30:00.000Z",
      "kiosk_url": "string",
      "walk_ins_today": 0,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "pairing": {
      "code": "string",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "pair_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/kiosks/{id}/revoke

Revoke a kiosk

The device token and any pairing code stop working at once; its site-office QR codes are paused.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Kiosk
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "site_name": "string",
    "status": "pending",
    "token_prefix": "string",
    "token_hint": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "settings": {
      "welcome_title": "string",
      "welcome_text": "string",
      "accent": "string",
      "language": "en",
      "otp": "required",
      "ask_lead_type": true,
      "configurations": [
        "string"
      ],
      "budget_bands": [
        {
          "key": "string",
          "label": "string",
          "min": 0,
          "max": 0
        }
      ],
      "came_via": [
        "walk_in"
      ],
      "ask_email": true,
      "ask_notes": true,
      "notify_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "default_owner_id": "cmusrceel0000q7kaafxqi1om",
      "idle_reset_sec": 0
    },
    "notify_members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "default_owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "paired_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "app_version": "string",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "pairing_expires_at": "2026-10-06T05:30:00.000Z",
    "kiosk_url": "string",
    "walk_ins_today": 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.

GET/v1/walk-ins

The site-office queue

Walk-ins of a local day (default today) in arrival order, with tokens, waiting times and who has the visitor. Scope: site_visits.view — “all” sees the whole queue, narrower scopes their own and those of leads they see.

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

Parameters

datequery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
kiosk_idquery: Id
Opaque record id.
project_idquery: Id
Opaque record id.
statusquery: "waiting" | "with_agent" | "done" | "left"

Response · 200

datarequired: WalkInQueue
metarequired: object

Request

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

Response example

{
  "data": {
    "date": "2026-10-06",
    "summary": {
      "total": 0,
      "waiting": 0,
      "with_agent": 0,
      "done": 0,
      "left": 0,
      "avg_wait_min": 0,
      "longest_wait_min": 0,
      "avg_service_min": 0
    },
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "token": "string",
        "token_no": 0,
        "token_reassigned": true,
        "status": "waiting",
        "came_via": "string",
        "came_via_note": "string",
        "verification": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "synced_at": "2026-10-06T05:30:00.000Z",
        "captured_offline": true,
        "synced_late": true,
        "attended_at": "2026-10-06T05:30:00.000Z",
        "done_at": "2026-10-06T05:30:00.000Z",
        "left_at": "2026-10-06T05:30:00.000Z",
        "wait_min": 0,
        "service_min": 0,
        "repeat_visitor": true,
        "outcome": "string",
        "visitor": "string",
        "lead": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref": "string",
          "owner": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          }
        },
        "kiosk": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "site_name": "string"
        },
        "project": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "attended_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "partner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "firm_name": "string",
          "claim_status": "string",
          "claim_note": "string"
        },
        "answers": {
          "lead_type": "string",
          "configurations": [
            "string"
          ],
          "budget": "string"
        },
        "site_visit_id": "cmusrceel0000q7kaafxqi1om",
        "actions": [
          "attend"
        ],
        "can_start_visit": true
      }
    ],
    "sites": [
      {
        "kiosk_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "site_name": "string",
        "project_id": "cmusrceel0000q7kaafxqi1om"
      }
    ]
  },
  "meta": {}
}

Errors

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

A walk-in

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: WalkIn
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "token": "string",
    "token_no": 0,
    "token_reassigned": true,
    "status": "waiting",
    "came_via": "string",
    "came_via_note": "string",
    "verification": "string",
    "captured_at": "2026-10-06T05:30:00.000Z",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "captured_offline": true,
    "synced_late": true,
    "attended_at": "2026-10-06T05:30:00.000Z",
    "done_at": "2026-10-06T05:30:00.000Z",
    "left_at": "2026-10-06T05:30:00.000Z",
    "wait_min": 0,
    "service_min": 0,
    "repeat_visitor": true,
    "outcome": "string",
    "visitor": "string",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "kiosk": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "site_name": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "attended_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string",
      "claim_status": "string",
      "claim_note": "string"
    },
    "answers": {
      "lead_type": "string",
      "configurations": [
        "string"
      ],
      "budget": "string"
    },
    "site_visit_id": "cmusrceel0000q7kaafxqi1om",
    "actions": [
      "attend"
    ],
    "can_start_visit": 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/walk-ins/{id}/status

Move a walk-in through the queue

attend (someone takes the visitor), done, left (gone before anyone saw them) or requeue.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "attend" | "done" | "left" | "requeue"
member_id: Id or null
attend: who takes the visitor (default: you).

Response · 200

datarequired: WalkIn
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/walk-ins/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"attend","member_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "token": "string",
    "token_no": 0,
    "token_reassigned": true,
    "status": "waiting",
    "came_via": "string",
    "came_via_note": "string",
    "verification": "string",
    "captured_at": "2026-10-06T05:30:00.000Z",
    "synced_at": "2026-10-06T05:30:00.000Z",
    "captured_offline": true,
    "synced_late": true,
    "attended_at": "2026-10-06T05:30:00.000Z",
    "done_at": "2026-10-06T05:30:00.000Z",
    "left_at": "2026-10-06T05:30:00.000Z",
    "wait_min": 0,
    "service_min": 0,
    "repeat_visitor": true,
    "outcome": "string",
    "visitor": "string",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "kiosk": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "site_name": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "attended_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string",
      "claim_status": "string",
      "claim_note": "string"
    },
    "answers": {
      "lead_type": "string",
      "configurations": [
        "string"
      ],
      "budget": "string"
    },
    "site_visit_id": "cmusrceel0000q7kaafxqi1om",
    "actions": [
      "attend"
    ],
    "can_start_visit": 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.
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/walk-ins/{id}/visit

Start the site visit of a walk-in

A site visit now, at the kiosk’s project, with whoever has the visitor and the partner who brought them.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 201

datarequired: object
data.walk_inrequired: WalkIn
data.visit_idrequired: Id
Opaque record id.
metarequired: object

Request

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

Response example

{
  "data": {
    "walk_in": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "token": "string",
      "token_no": 0,
      "token_reassigned": true,
      "status": "waiting",
      "came_via": "string",
      "came_via_note": "string",
      "verification": "string",
      "captured_at": "2026-10-06T05:30:00.000Z",
      "synced_at": "2026-10-06T05:30:00.000Z",
      "captured_offline": true,
      "synced_late": true,
      "attended_at": "2026-10-06T05:30:00.000Z",
      "done_at": "2026-10-06T05:30:00.000Z",
      "left_at": "2026-10-06T05:30:00.000Z",
      "wait_min": 0,
      "service_min": 0,
      "repeat_visitor": true,
      "outcome": "string",
      "visitor": "string",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "owner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      },
      "kiosk": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "site_name": "string"
      },
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "attended_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string",
        "claim_status": "string",
        "claim_note": "string"
      },
      "answers": {
        "lead_type": "string",
        "configurations": [
          "string"
        ],
        "budget": "string"
      },
      "site_visit_id": "cmusrceel0000q7kaafxqi1om",
      "actions": [
        "attend"
      ],
      "can_start_visit": true
    },
    "visit_id": "cmusrceel0000q7kaafxqi1om"
  },
  "meta": {}
}

Errors

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

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string", "status": "pending", "token_prefix": "string", "token_hint": "string", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "settings": { "welcome_title": "string", "welcome_text": "string", "accent": "string", "language": "en", "otp": "required", "ask_lead_type": true, "configurations": [ "string" ], "budget_bands": [ { "key": "string", "label": "string", "min": 0, "max": 0 } ], "came_via": [ "walk_in" ], "ask_email": true, "ask_notes": true, "notify_member_ids": [ "cmusrceel0000q7kaafxqi1om" ], "default_owner_id": "cmusrceel0000q7kaafxqi1om", "idle_reset_sec": 0 }, "notify_members": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "default_owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "paired_at": "2026-10-06T05:30:00.000Z", "last_seen_at": "2026-10-06T05:30:00.000Z", "app_version": "string", "revoked_at": "2026-10-06T05:30:00.000Z", "pairing_expires_at": "2026-10-06T05:30:00.000Z", "kiosk_url": "string", "walk_ins_today": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/kiosks' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","site_name":"string","project_id":"cmusrceel0000q7kaafxqi1om","source_id":"cmusrceel0000q7kaafxqi1om","settings":{"welcome_title":"string","welcome_text":"string","accent":"string","language":"en","otp":"required","ask_lead_type":true,"configurations":["string"],"budget_bands":[{"key":"string","label":"string","min":0,"max":0}],"came_via":["walk_in"],"ask_email":true,"ask_notes":true,"notify_member_ids":["cmusrceel0000q7kaafxqi1om"],"default_owner_id":"cmusrceel0000q7kaafxqi1om","idle_reset_sec":30}}'

{ "data": { "kiosk": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string", "status": "pending", "token_prefix": "string", "token_hint": "string", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "settings": { "welcome_title": "string", "welcome_text": "string", "accent": "string", "language": "en", "otp": "required", "ask_lead_type": true, "configurations": [ "string" ], "budget_bands": [ { "key": "string", "label": "string", "min": 0, "max": 0 } ], "came_via": [ "walk_in" ], "ask_email": true, "ask_notes": true, "notify_member_ids": [ "cmusrceel0000q7kaafxqi1om" ], "default_owner_id": "cmusrceel0000q7kaafxqi1om", "idle_reset_sec": 0 }, "notify_members": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "default_owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "paired_at": "2026-10-06T05:30:00.000Z", "last_seen_at": "2026-10-06T05:30:00.000Z", "app_version": "string", "revoked_at": "2026-10-06T05:30:00.000Z", "pairing_expires_at": "2026-10-06T05:30:00.000Z", "kiosk_url": "string", "walk_ins_today": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "pairing": { "code": "string", "expires_at": "2026-10-06T05:30:00.000Z", "pair_url": "string" } }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/kiosks/policy' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"cp_lock_days":7,"consent_text":"string","verify_later":true}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string", "status": "pending", "token_prefix": "string", "token_hint": "string", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "source": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "settings": { "welcome_title": "string", "welcome_text": "string", "accent": "string", "language": "en", "otp": "required", "ask_lead_type": true, "configurations": [ "string" ], "budget_bands": [ { "key": "string", "label": "string", "min": 0, "max": 0 } ], "came_via": [ "walk_in" ], "ask_email": true, "ask_notes": true, "notify_member_ids": [ "cmusrceel0000q7kaafxqi1om" ], "default_owner_id": "cmusrceel0000q7kaafxqi1om", "idle_reset_sec": 0 }, "notify_members": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "default_owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "paired_at": "2026-10-06T05:30:00.000Z", "last_seen_at": "2026-10-06T05:30:00.000Z", "app_version": "string", "revoked_at": "2026-10-06T05:30:00.000Z", "pairing_expires_at": "2026-10-06T05:30:00.000Z", "kiosk_url": "string", "walk_ins_today": 0, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/kiosks/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"name":"string","site_name":"string","project_id":"cmusrceel0000q7kaafxqi1om","source_id":"cmusrceel0000q7kaafxqi1om","settings":{"welcome_title":"string","welcome_text":"string","accent":"string","language":"en","otp":"required","ask_lead_type":true,"configurations":["string"],"budget_bands":[{"key":"string","label":"string","min":0,"max":0}],"came_via":["walk_in"],"ask_email":true,"ask_notes":true,"notify_member_ids":["cmusrceel0000q7kaafxqi1om"],"default_owner_id":"cmusrceel0000q7kaafxqi1om","idle_reset_sec":30}}'

{ "data": { "date": "2026-10-06", "summary": { "total": 0, "waiting": 0, "with_agent": 0, "done": 0, "left": 0, "avg_wait_min": 0, "longest_wait_min": 0, "avg_service_min": 0 }, "items": [ { "id": "cmusrceel0000q7kaafxqi1om", "token": "string", "token_no": 0, "token_reassigned": true, "status": "waiting", "came_via": "string", "came_via_note": "string", "verification": "string", "captured_at": "2026-10-06T05:30:00.000Z", "synced_at": "2026-10-06T05:30:00.000Z", "captured_offline": true, "synced_late": true, "attended_at": "2026-10-06T05:30:00.000Z", "done_at": "2026-10-06T05:30:00.000Z", "left_at": "2026-10-06T05:30:00.000Z", "wait_min": 0, "service_min": 0, "repeat_visitor": true, "outcome": "string", "visitor": "string", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "kiosk": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string" }, "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "attended_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "partner": { "id": "cmusrceel0000q7kaafxqi1om", "firm_name": "string", "claim_status": "string", "claim_note": "string" }, "answers": { "lead_type": "string", "configurations": [ "string" ], "budget": "string" }, "site_visit_id": "cmusrceel0000q7kaafxqi1om", "actions": [ "attend" ], "can_start_visit": true } ], "sites": [ { "kiosk_id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string", "project_id": "cmusrceel0000q7kaafxqi1om" } ] }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "token": "string", "token_no": 0, "token_reassigned": true, "status": "waiting", "came_via": "string", "came_via_note": "string", "verification": "string", "captured_at": "2026-10-06T05:30:00.000Z", "synced_at": "2026-10-06T05:30:00.000Z", "captured_offline": true, "synced_late": true, "attended_at": "2026-10-06T05:30:00.000Z", "done_at": "2026-10-06T05:30:00.000Z", "left_at": "2026-10-06T05:30:00.000Z", "wait_min": 0, "service_min": 0, "repeat_visitor": true, "outcome": "string", "visitor": "string", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "kiosk": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string" }, "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "attended_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "partner": { "id": "cmusrceel0000q7kaafxqi1om", "firm_name": "string", "claim_status": "string", "claim_note": "string" }, "answers": { "lead_type": "string", "configurations": [ "string" ], "budget": "string" }, "site_visit_id": "cmusrceel0000q7kaafxqi1om", "actions": [ "attend" ], "can_start_visit": true }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/walk-ins/{id}/status' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"action":"attend","member_id":"cmusrceel0000q7kaafxqi1om"}'

{ "data": { "walk_in": { "id": "cmusrceel0000q7kaafxqi1om", "token": "string", "token_no": 0, "token_reassigned": true, "status": "waiting", "came_via": "string", "came_via_note": "string", "verification": "string", "captured_at": "2026-10-06T05:30:00.000Z", "synced_at": "2026-10-06T05:30:00.000Z", "captured_offline": true, "synced_late": true, "attended_at": "2026-10-06T05:30:00.000Z", "done_at": "2026-10-06T05:30:00.000Z", "left_at": "2026-10-06T05:30:00.000Z", "wait_min": 0, "service_min": 0, "repeat_visitor": true, "outcome": "string", "visitor": "string", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "kiosk": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "site_name": "string" }, "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "attended_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "partner": { "id": "cmusrceel0000q7kaafxqi1om", "firm_name": "string", "claim_status": "string", "claim_note": "string" }, "answers": { "lead_type": "string", "configurations": [ "string" ], "budget": "string" }, "site_visit_id": "cmusrceel0000q7kaafxqi1om", "actions": [ "attend" ], "can_start_visit": true }, "visit_id": "cmusrceel0000q7kaafxqi1om" }, "meta": {} }