PublicBookingIntent | SavvyCal Appointments

A public booking intent that tracks the lifecycle of a booking attempt. This is a simplified view without sensitive or admin-only fields.

Example

{  "appointment": null,  "end_at": {    "local": "2026-02-23T10:30:00-05:00",    "object": "zoned_date_time",    "time_zone": "America/New_York",    "unix_ts": 1771947000,    "utc": "2026-02-23T15:30:00Z"  },  "errors": null,  "hold_until": "2026-02-22T10:10:00Z",  "id": "bi_abc123def456abc123def456",  "locked_fields": [],  "object": "public_booking_intent",  "requirements": {    "booking": {      "complete": true    },    "info": {      "complete": false    },    "submissions": [      {        "complete": false,        "form_id": "frm_abc123def456"      }    ]  },  "start_at": {    "local": "2026-02-23T10:00:00-05:00",    "object": "zoned_date_time",    "time_zone": "America/New_York",    "unix_ts": 1771945200,    "utc": "2026-02-23T15:00:00Z"  },  "status": "slot_selected",  "workflow": {    "available_steps": [      "booking",      "info",      "form:frm_abc123def456"    ],    "can_change_slot": true,    "can_complete": false,    "defunct_reason": null,    "is_defunct": false,    "resume_step": "info"  }}

appointment?

The created appointment. Present when status is completed.

end_at?

The end time of the selected slot

errors?array<>|

Validation errors for data provided so far. Fields not yet submitted are not flagged. Null when not computed.

hold_until?|

When the hold expires (UTC)

Formatdate-time

id*string

The booking intent ID

Match^bi_\w{24}$

locked_fields?array<>

Fields that are locked and cannot be updated via the public API.

object*"public_booking_intent"

The object type

Value in

"public_booking_intent"

requirements?

Per-section completeness status for a booking intent. Provides boolean signals for whether each section of the booking flow has enough data to proceed, enabling the frontend to make navigation decisions without parsing error pointers.

Example

{  "booking": {    "complete": true  },  "info": {    "complete": false  },  "submissions": [    {      "complete": false,      "form_id": "frm_abc123def456"    }  ]}

start_at?

The start time of the selected slot

status*string

The current status of the booking intent. Automatically transitions from pending to slot_selected when provider_id, start_at, end_at, and time_zone are all present (on create or update).

Value in

"pending"
"slot_selected"
"completed"
"abandoned"

workflow?

Server-computed workflow state for a booking intent. Provides step routing, completability, and defunct state so the frontend can render the correct booking flow without inferring these from raw fields.

Example

{  "available_steps": [    "booking",    "info",    "form:frm_abc123def456"  ],  "can_change_slot": true,  "can_complete": false,  "defunct_reason": null,  "is_defunct": false,  "resume_step": "info"}