listEventsByContactId( )

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 contact ID.

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

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Including Participants
Read bookings calendar - including participants
Manage Calendars
Read Calendar - Including PI
Learn more about app permissions.
Method Declaration
Copy
function listEventsByContactId(
  contactId: string,
  options: ListEventsByContactIdOptions,
): Promise<ListEventsByContactIdResponse>;
Method Parameters
contactIdstringRequired

ID of the contact to retrieve events for. Required, unless you provide cursorPaging.

optionsListEventsByContactIdOptions
Returns
Return Type:Promise<ListEventsByContactIdResponse>
JavaScript
import { events } from "@wix/calendar";

async function listEventsByContactId(contactId, options) {
  const response = await events.listEventsByContactId(contactId, options);
}
Errors

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

Did this help?