Permissions

By default, site visitors can see only public information for schedules and events. They can't access any personal information. For your app, you can choose the permission scopes that give the necessary access and request which data is returned in each method of the Schedules and Events APIs.

Retrieve personal information

Use the field parameter in requests for the Schedules and Events APIs to customize which fields are included in the response.

Value passed in field	Returned fields and values
null or not provided	Only non-personal fields are returned. For a list of fields considered personal, see Events: Fields with personal information and Schedules: Fields with personal information.
PI_FIELDS	Returns complete objects, including all values. Requires the Read Calendars - Including PI permission scope.
OWN_PI_FIELDS	Returns complete objects, but excludes personal information of anyone other than the caller's identity from the returned values.

Events: Fields with personal information

In methods of the Events API, the following fields aren’t returned by default:

• participants
• conferencingDetails
• notes
• location.name and location.address (if location.type is set to CUSTOMER)

These fields are only returned if you set fields to PI_FIELDS or OWN_PI_FIELDS and your app has the necessary permissions.

Schedules: Fields with personal information

In methods of the Schedules API, the following fields aren’t returned by default:

• defaultConferencingDetails
• defaultLocation.name and defaultLocation.address (if defaultLocation.type is set to CUSTOMER)

These fields are only returned if you set fields to PI_FIELDS or OWN_PI_FIELDS and your app has the necessary permissions.

Roles

For both schedules and events, you can assign roles to Wix users giving them specific access to the relevant entity.

This table summarizes permission roles and their access levels:

Role	Access Level
WRITER	Full read and write access.
COMMENTER	Full read access, write access limited to event.notes.

Roles for schedules

To grant a Wix user access to a schedule, include the relevant ID in schedule.permissions.identity.wixUserId and specify their role in schedule.permissions.role.

Roles for events

You can assign access levels to Bookings staff members associated with an event by specifying their role in the event.resources.permissionRole field. By default, Bookings staff members don't have access to classes they conduct, as the schedule is linked to the service rather than the individual staff member.

To check which additional Wix users have access to the event, refer to the event.permissions.identity.wixUserId field along with the corresponding event.permissions.role.