Skip to content

Get Next available group appointment time

Request

Security
x-api-key and a-api-key
Query
fromstring, (date)required

Cannot be more than 7 days before the to parameter and cannot be before the current date in the tenant's time zone.

Example:from=2026-01-01
tostring, (date)required

Cannot be more than 7 days after the from parameter and cannot be before the current date in the tenant's time zone.

Example:to=2026-01-07
appointment_type_idintegerrequired
business_idsArray of integers
practitioner_idsArray of integers
profession_idsArray of integers
bufferinteger

Minutes added to the current time when searching for availability. Only group appointment times starting after now + buffer are returned.

Default:60
GET
/next_available_group_appointment
curl -i -X GET \
  'https://api.pracsuite.com/v1/next_available_group_appointment?from=2026-01-01&to=2026-01-07&appointment_type_id=0&business_ids=0&practitioner_ids=0&profession_ids=0&buffer=60' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
available_group_appointmentsArray of objects(Available Group Appointment)
total_entriesinteger
Response
{ "available_group_appointments": [ {} ], "total_entries": 0, "links": { "self": "https://api.pracsuite.com/v1/next_available_group_appointment?page=2&appointment_type_id=1&from=2025-01-01&to=2025-01-07" } }