Skip to content
/
Appointment Book

Appointment Book

tenant_idinteger
appointment_idinteger
app_timestring^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}$

ISO 8601 local datetime in the tenant's timezone.

Example:"2026-01-01T12:05:30"
descriptionstring
client_idinteger
account_idinteger
appointment_type_idinteger
appointment_status_idinteger
categorystring
durationinteger
notesstring
practitioner_idinteger
business_idinteger
profession_idinteger
item_idinteger
createdstring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
modifiedstring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
item_group_idinteger
font_colourstring

Hex colour in the format #RRGGBB.

Example:"#000000"
bg_colourstring

Hex colour in the format #RRGGBB.

Example:"#FFD700"
max_class_sizeinteger

If the return value is 0, this means the group has no class size limit

appointment_clientsArray of objects
resource_idsArray of integers
{
  "links": {
    "self": "https://api.pracsuite.com/v1/group_appointment/1",
    "resources": "https://api.pracsuite.com/v1/group_appointment/1/resource",
    "appointment_clients": "https://api.pracsuite.com/v1/group_appointment/1/appointment_client"
  },
  "tenant_id": 0,
  "appointment_id": 0,
  "app_time": "2026-01-01T12:05:30",
  "description": "string",
  "client_id": 0,
  "account_id": 0,
  "appointment_type_id": 0,
  "appointment_status_id": 0,
  "category": "string",
  "duration": 0,
  "notes": "string",
  "practitioner_id": 0,
  "business_id": 0,
  "profession_id": 0,
  "item_id": 0,
  "created": "2020-09-12T11:09:42.687393Z",
  "modified": "2020-09-12T11:09:42.687393Z",
  "item_group_id": 0,
  "font_colour": "#000000",
  "bg_colour": "#FFD700",
  "telehealth_patient_link": "string",
  "telehealth_practitioner_link": "string",
  "max_class_size": 0,
  "appointment_clients": [
    { … }
  ],
  "resource_ids": [
    0
  ]
}