About the Staff Members API

The Staff Members API enables you to manage the staff of a business and their working hour schedules. If a staff member is a Wix user, they can manage their own schedule through the dashboard.

With the Staff Members API, you can:

• Manage staff members.
• Manage staff schedules.
• Connect and disconnect Wix users to staff members.

Before you begin

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

• Wix Bookings must be installed on a site before you can use the Staff Members API.
• Wix Bookings automatically manages a special resource type for all staff members. To avoid data conflicts, don't use the Resources V2 and Resource Types V2 APIs to manage staff.
• By default, staff members work during the opening hours of the business's default location. You can define custom hours by calling Assign Working Hours Schedule to Staff Member and then creating WORKING_HOURS events with the Calendar Events V3 API. See how Wix Bookings uses the Calendar APIs and the set a staff member's weekly working hours sample flow for more details.
• To block a staff member's availability for vacation days or time off, create an OPAQUE event on their event schedule using the Calendar Events V3 API. See the block a staff member's availability for a vacation day sample flow.
• To get a staff member's event schedule ID, call Get Staff Member with RESOURCE_DETAILS in the fields parameter and read the resource.eventsSchedule.id field.

Use Cases

• Connect a staff member to a Wix user.
• Set a staff member's weekly working hours.
• Block a staff member's availability for a vacation day.

Terminology

• Staff member: An individual providing services within Wix Bookings.
• Resource: An asset, such as a meeting room or equipment, needed to deliver services to customers.
• Resource type: A classification that connects resources, making them bookable.
• Working hour schedule: A schedule defining when a staff member is available for bookings. Learn more about how Wix Bookings uses the Calendar APIs.
• Wix user: An individual logged into their account on .wix.com. This includes site owners, collaborators, and app owners. Not all staff members are Wix users, and not all users connected to a Wix Bookings site are staff members. Learn more about identities.

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

See also

• Related APIs:
  • Services
  • Calendar APIs
  • Calendar Events
  • Calendar Schedules
  • Resources
  • Resource Types
  • Locations
• How business owners can:
  • Manage their resources.
  • Manage their staff.