GET - Group Events

Retrieves the Business Schedule's Events for the specified group.

Parameters

  • service_provider_id (str): Target Service Provider ID

  • group_id (str): Target Group ID

  • name (str): Name of the target Busisness Schedule

  • type (str): The type of the Business Schedule (Time, Holiday)

Returns

  • List: List of each Business Schedule Event, including startTime and endTime.

How To Use:

my_api.schedules.get_group_events(
    "serviceProviderID",
    "groupID",
    "eventName",
    "Holiday"
)

Example Response (Formatted)

[
  {
    "eventName": "Test / Event",
    "startTime": "2018-09-15T00:00:00",
    "endTime": "2018-09-16T00:00:00",
    "allDayEvent": true,
    "name": "Test1234",
    "type": "Holiday",
    "serviceProviderId": "serviceProvider",
    "groupId": "groupID",
    "rrule": "DTSTART:20180915T040000Z\nRRULE:FREQ=DAILY"
  }
]

Last updated

Was this helpful?