latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Gets calendar events for a given staff. Staff members can only retrieve their own calendar events. Endpoint also supports Service Identity.

get/Business/Calendars/Staff/{staffId}

Path parameters

staffIdinteger required

Query parameters

request.startDateTimestring date-time

Optional start datetime to filter the request on in ISO-8601.

request.endDateTimestring date-time

Optional end datetime to filter the request on in ISO-8601.

request.includeAppointmentsboolean

Whether to include appointments in the result set.

request.includeClassesboolean

Whether to include classes in the result set.

request.includeEnrollmentsboolean

Whether to include enrollments in the result set.

request.includeUnavailabilitiesboolean

Whether to include unavailabilities in the result set.

request.locationIdsinteger[]

Optional list of location identifiers to filter the results on.

Headers

SiteIdinteger required

Site ID

Response

OK

EventIdinteger

Event unique identifier:

  • For appointment events, this will be the appointment id or visit ref no.
  • For class events, this will be the class instance id.
  • For unavailability events, this will be the unavailability id.
EventNamestring

Name of the event.

EventType'core.appointment' | 'core.classInstance' | 'core.unavailability'

Event type. Possible values are availble here: {Mindbody.RestApi.Dto.Enums.ECalendarEventType}.

StaffIdinteger

Staff that the event belong to.

StartTimestring date-time

The start time/date of the event in Coordinated Universal Time or UTC.

EndTimestring date-time

The end time/date of the event in Coordinated Universal Time or UTC.

Unscheduledboolean

Whether the event represents an unscheduled or TBD class.