listEventsByMemberId( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of events filtered by the participant's member ID.

You can't set toLocalDate to a value that's more than a full year after fromLocalDate.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read Bookings Calendar Availability
Read bookings calendar - including participants
Read Bookings Calendar
Manage Calendars
Read Calendar - Including PI
Read Calendar
Learn more about app permissions.
Method Declaration
Copy
function listEventsByMemberId(
  memberId: string,
  options: ListEventsByMemberIdOptions,
): Promise<ListEventsByMemberIdResponse>;
Method Parameters
memberIdstringRequired

ID of the member to retrieve events for. Required, unless you provide cursorPaging. Provide me to retrieve events for the currently logged-in member. You must have the Read Calendars - Including PI permission scope to retrieve events for members who aren't the currently logged in member.


optionsListEventsByMemberIdOptions
Returns
Return Type:Promise<ListEventsByMemberIdResponse>
JavaScript
import { events } from "@wix/calendar"; async function listEventsByMemberId(memberId, options) { const response = await events.listEventsByMemberId(memberId, options); }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?