Appointment objects returned from these endpoints follow the following model

Attribute

Type

Description

id

string (uuid)

A unique identifier for an appointment. Used towards other endpoints requiring an id.

name

string

The name of the visitor as they wish to represent themselves

phoneNumber

string

The phone number of the visitor, if applicable

email

string

The email of the visitor if applicable

metadata

Object

Metadata about the appointment

lastHeartbeat

Object

The last Heartbeat of the user. This contains information about when the initial heartbeat started and the time of the last heartbeat received. Use this to calculate total waiting time.

client

Object

An object containing information about the visitor which was in the waiting room. Null if nobody has been in the waiting room yet.

purchase

Object

The purchase made for the appointment if applicable. This is only relevant if you use services.

service

Object

The service which was selected when creating this appointment, if applicable. Null if no service present.

professional

Object

A User object containing information about the professional the visitor will meet or has met.

organization

Object

The organization of the appointment.

conversation

Object

A Conversation object, containing information on the conversation that happened as a result of this appointment.

{
  id: "13901bbe-3ebd-4780-b9f0-b432245f9991",
  name: "John Doe",
  phoneNumber: null,
  email: null,
  metadata: {},
  lastHeartbeat: Heartbeat,
  client: Client,
  purchase: Purchase,
  service: Service,
  professional: Professional,
  organization: Organization,
  conversation: Conversation,
}