SiteVisit

object

idrequired: Id
Opaque record id.
statusrequired: SiteVisitStatus
phaserequired: "upcoming" | "in_progress" | "done" | "no_show" | "cancelled"
upcoming · in_progress (checked in) · done · no_show · cancelled
leadrequired: object
lead.idrequired: Id
Opaque record id.
lead.refrequired: string
lead.namerequired: string
lead.contact_idrequired: Id
Opaque record id.
agentrequired: MemberRef or null
presalesrequired: MemberRef or null
created_by_idrequired: Id or null
Opaque record id.
projectrequired: object or null
project.idrequired: Id
Opaque record id.
project.namerequired: string
scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
ends_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
duration_minrequired: integer
visit_numberrequired: integer
meeting_pointrequired: string or null
pickuprequired: object
pickup.requiredrequired: boolean
pickup.addressrequired: string or null
pickup.atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
partner_idrequired: Id or null
Opaque record id.
itemsrequired: array of SiteVisitItem
confirmedrequired: object or null
confirmed.atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
confirmed.viarequired: "link" | "agent"
otprequired: object
otp.requiredrequired: boolean
otp.verified_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
otp.methodrequired: "otp" | "override" or null
otp.channelrequired: string or null
otp.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
otp.expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
otp.attempts_leftrequired: integer
otp.lockedrequired: boolean
otp.resend_in_secrequired: integer
check_inrequired: object or null
check_in.atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
check_in.latrequired: number or null
check_in.lngrequired: number or null
check_in.accuracy_mrequired: number or null
check_in.distance_mrequired: number or null
check_in.farrequired: boolean
check_in.mockrequired: boolean
check_in.has_photorequired: boolean
check_outrequired: object or null
check_out.atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
check_out.latrequired: number or null
check_out.lngrequired: number or null
check_out.distance_mrequired: number or null
check_out.mockrequired: boolean
completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
actual_minutesrequired: integer or null
ratingrequired: integer or null
notesrequired: string or null
next_steprequired: string or null
objectionsrequired: array of string
revisit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
feedback_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cancelled_reasonrequired: string or null
no_show_reasonrequired: string or null
reschedulesrequired: array of object
reschedules[].fromrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
reschedules[].torequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
reschedules[].reasonrequired: string or null
reschedules[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
requestsrequired: array of object
What the client asked for on the confirmation page; open until the visit is rescheduled, or it closes.
requests[].idrequired: Id
Opaque record id.
requests[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
requests[].preferred_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
requests[].noterequired: string or null
requests[].statusrequired: "open" | "rescheduled" | "dismissed"
confirm_urlrequired: string or null
The client’s confirm / reschedule link (for members who may change the visit).
can_editrequired: boolean
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "status": "scheduled",
  "phase": "upcoming",
  "lead": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "name": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om"
  },
  "agent": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "presales": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "created_by_id": "cmusrceel0000q7kaafxqi1om",
  "project": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "scheduled_at": "2026-10-06T05:30:00.000Z",
  "ends_at": "2026-10-06T05:30:00.000Z",
  "duration_min": 0,
  "visit_number": 0,
  "meeting_point": "string",
  "pickup": {
    "required": true,
    "address": "string",
    "at": "2026-10-06T05:30:00.000Z"
  },
  "partner_id": "cmusrceel0000q7kaafxqi1om",
  "items": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "sort_order": 0,
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string",
        "listing_type": "string",
        "locality": "string"
      },
      "unit": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string"
      },
      "planned_at": "2026-10-06T05:30:00.000Z",
      "reaction": "liked",
      "reasons": [
        "string"
      ],
      "remarks": "string"
    }
  ],
  "confirmed": {
    "at": "2026-10-06T05:30:00.000Z",
    "via": "link"
  },
  "otp": {
    "required": true,
    "verified_at": "2026-10-06T05:30:00.000Z",
    "method": "otp",
    "channel": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "attempts_left": 0,
    "locked": true,
    "resend_in_sec": 0
  },
  "check_in": {
    "at": "2026-10-06T05:30:00.000Z",
    "lat": 0,
    "lng": 0,
    "accuracy_m": 0,
    "distance_m": 0,
    "far": true,
    "mock": true,
    "has_photo": true
  },
  "check_out": {
    "at": "2026-10-06T05:30:00.000Z",
    "lat": 0,
    "lng": 0,
    "distance_m": 0,
    "mock": true
  },
  "completed_at": "2026-10-06T05:30:00.000Z",
  "actual_minutes": 0,
  "rating": 0,
  "notes": "string",
  "next_step": "string",
  "objections": [
    "string"
  ],
  "revisit_at": "2026-10-06T05:30:00.000Z",
  "feedback_at": "2026-10-06T05:30:00.000Z",
  "cancelled_reason": "string",
  "no_show_reason": "string",
  "reschedules": [
    {
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z",
      "reason": "string",
      "at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "requests": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z",
      "preferred_at": "2026-10-06T05:30:00.000Z",
      "note": "string",
      "status": "open"
    }
  ],
  "confirm_url": "string",
  "can_edit": true,
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z"
}

{ "id": "cmusrceel0000q7kaafxqi1om", "status": "scheduled", "phase": "upcoming", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string", "contact_id": "cmusrceel0000q7kaafxqi1om" }, "agent": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "presales": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_by_id": "cmusrceel0000q7kaafxqi1om", "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "scheduled_at": "2026-10-06T05:30:00.000Z", "ends_at": "2026-10-06T05:30:00.000Z", "duration_min": 0, "visit_number": 0, "meeting_point": "string", "pickup": { "required": true, "address": "string", "at": "2026-10-06T05:30:00.000Z" }, "partner_id": "cmusrceel0000q7kaafxqi1om", "items": [ { "id": "cmusrceel0000q7kaafxqi1om", "sort_order": 0, "property": { "id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string", "listing_type": "string", "locality": "string" }, "unit": { "id": "cmusrceel0000q7kaafxqi1om", "unit_no": "string" }, "planned_at": "2026-10-06T05:30:00.000Z", "reaction": "liked", "reasons": [ "string" ], "remarks": "string" } ], "confirmed": { "at": "2026-10-06T05:30:00.000Z", "via": "link" }, "otp": { "required": true, "verified_at": "2026-10-06T05:30:00.000Z", "method": "otp", "channel": "string", "sent_at": "2026-10-06T05:30:00.000Z", "expires_at": "2026-10-06T05:30:00.000Z", "attempts_left": 0, "locked": true, "resend_in_sec": 0 }, "check_in": { "at": "2026-10-06T05:30:00.000Z", "lat": 0, "lng": 0, "accuracy_m": 0, "distance_m": 0, "far": true, "mock": true, "has_photo": true }, "check_out": { "at": "2026-10-06T05:30:00.000Z", "lat": 0, "lng": 0, "distance_m": 0, "mock": true }, "completed_at": "2026-10-06T05:30:00.000Z", "actual_minutes": 0, "rating": 0, "notes": "string", "next_step": "string", "objections": [ "string" ], "revisit_at": "2026-10-06T05:30:00.000Z", "feedback_at": "2026-10-06T05:30:00.000Z", "cancelled_reason": "string", "no_show_reason": "string", "reschedules": [ { "from": "2026-10-06T05:30:00.000Z", "to": "2026-10-06T05:30:00.000Z", "reason": "string", "at": "2026-10-06T05:30:00.000Z" } ], "requests": [ { "id": "cmusrceel0000q7kaafxqi1om", "at": "2026-10-06T05:30:00.000Z", "preferred_at": "2026-10-06T05:30:00.000Z", "note": "string", "status": "open" } ], "confirm_url": "string", "can_edit": true, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }