Skip to main content

PublicAppointmentResponse

Response schema for a single appointment created via a public interface.

data objectrequired

A public appointment represents a booking that a client has made with a provider for a service.

cancellation objectrequired

Information about whether the appointment can be canceled by the client.

allowedbooleanrequired

Whether the appointment can be canceled by the client.

disabled_messagestringnullablerequired

A message explaining why cancellation is disabled, if applicable. Only present when allowed is false.

confirmed_atstring<date-time>nullablerequired

Time at which the object was confirmed.

end_at objectrequired

An object describing a date/time in local time and in UTC.

localstring<date-time>required

The local date/time in ISO-8601 format, including the UTC offset (e.g., 2025-03-01T10:00:00-05:00).

Example: 2025-03-01T10:00:00-05:00
objectstringrequired

String representing the object's type.

Possible values: [zoned_date_time]

time_zonestringrequired

The time zone of the local time (IANA format).

Example: America/New_York
unix_tsintegerrequired

The UTC date/time in Unix timestamp format (seconds).

Example: 1736461200
utcstring<date-time>required

The UTC date/time in ISO-8601 format (with time zone information).

Example: 2025-03-01T03:00:00Z
idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^appt_\w{12}$

objectstringrequired

String representing the object's type.

Possible values: [public_appointment]

rescheduling objectrequired

Information about whether the appointment can be rescheduled by the client.

allowedbooleanrequired

Whether the appointment can be rescheduled by the client.

disabled_messagestringnullablerequired

A message explaining why rescheduling is disabled, if applicable. Only present when allowed is false.

start_at objectrequired

An object describing a date/time in local time and in UTC.

localstring<date-time>required

The local date/time in ISO-8601 format, including the UTC offset (e.g., 2025-03-01T10:00:00-05:00).

Example: 2025-03-01T10:00:00-05:00
objectstringrequired

String representing the object's type.

Possible values: [zoned_date_time]

time_zonestringrequired

The time zone of the local time (IANA format).

Example: America/New_York
unix_tsintegerrequired

The UTC date/time in Unix timestamp format (seconds).

Example: 1736461200
utcstring<date-time>required

The UTC date/time in ISO-8601 format (with time zone information).

Example: 2025-03-01T03:00:00Z
statusstringrequired

The status of the appointment.

Possible values: [scheduled, canceled]

urls objectrequired

URLs related to the appointment for client-facing actions.

add_to_calendarstring<uri>[]required

URLs for adding the appointment to a calendar.

add_to_google_calendarstring<uri>[]required

URLs for adding the appointment to Google Calendar.

cancelstring<uri>[]required

URLs for canceling the appointment.

icsstring<uri>[]required

URLs for downloading an ICS file for the appointment.

reschedulestring<uri>[]required

URLs for rescheduling the appointment.

PublicAppointmentResponse
{
  "data": {
    "cancellation": {
      "allowed": true,
      "disabled_message": null
    },
    "confirmed_at": "2025-03-10T15:30:00Z",
    "end_at": {
      "local": "2025-03-01T11:00:00-05:00",
      "object": "zoned_date_time",
      "time_zone": "America/New_York",
      "unix_ts": 1736464800,
      "utc": "2025-03-01T04:00:00Z"
    },
    "id": "appt_a1b2c3d4e5f6",
    "object": "public_appointment",
    "rescheduling": {
      "allowed": false,
      "disabled_message": "Rescheduling is not available within 24 hours of your appointment"
    },
    "start_at": {
      "local": "2025-03-01T10:00:00-05:00",
      "object": "zoned_date_time",
      "time_zone": "America/New_York",
      "unix_ts": 1736461200,
      "utc": "2025-03-01T03:00:00Z"
    },
    "status": "scheduled",
    "urls": {
      "add_to_calendar": [
        "https://example.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
      ],
      "add_to_google_calendar": [
        "https://example.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
      ],
      "cancel": [
        "https://example.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
      ],
      "ics": [
        "https://example.com/c/appointments/appt_a1b2c3d4e5f6/ics"
      ],
      "reschedule": [
        "https://example.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
      ]
    }
  }
}