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 (SDK | REST) for all staff members. To avoid data conflicts, don't use the Resources V2 (SDK | REST) and Resource Types V2 (SDK | REST) APIs to manage staff.
  • By default, staff members work during the opening hours of the business's default location (SDK | REST). You can define custom hours by calling Assign Working Hours Schedule to Staff Member (SDK | REST). See how Wix Bookings uses the Calendar APIs (SDK | REST) and the assign a staff working hour schedule sample flow (SDK | REST) for more details.

Use Cases

  • Connect a staff member to a Wix user (SDK | REST).
  • Assign a staff working hour schedule (SDK | REST).

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 (SDK | REST) defining when a staff member is available for bookings. Learn more about how Wix Bookings uses the Calendar APIs (SDK | REST).
  • 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 (SDK | REST).

For a comprehensive glossary of Wix Bookings terms, see Terminology (SDK | REST).

See also

Did this help?