About the Staff Member Settings API

The Staff Member Settings API provides you with privacy controls for staff member contact information in Wix Bookings. By default, staff contact information is private. You can configure whether staff members' email addresses and phone numbers are returned in Staff Members API responses and whether contact information is displayed on the live site.

With the Staff Member Settings API, you can:

• Retrieve the current privacy settings for a site's staff contact information.
• Update privacy settings to control when contact information is accessible.
• Respond to privacy setting changes through events.

Before you begin

It's important to note the following points before starting to code:

• The publiclyAccessible setting controls whether staff contact information (email and phone properties) is accessible through the Staff Members API and displayed on the live site. When publiclyAccessible is false, contact information is hidden on the live site and not returned in the API unless the identity you're authenticated as has the BOOKINGS.STAFF_MEMBER_READ_PI permission.

Use cases

• Retrieve staff contact information.
• Update privacy settings.

Terminology

• Staff member settings: A singleton settings object that controls privacy for all staff members on a site. Each site has exactly 1 settings object.
• Contact information: Staff members' email addresses and phone numbers are stored in the email and phone properties of Staff Member objects.

For a comprehensive glossary of Wix Bookings terms, see Terminology.