Resources V1: Migration Guide

This guide helps you migrate from Resources V1 to the current recommended APIs. Resources V1 will be removed on June 30, 2025.

Overview

Resources V1 provided a single API for managing both staff members and general resources (rooms, equipment) as well as accessing the business resource for schedule information. The functionality has been redesigned and split into specialized APIs:

• Resource Types V2 API: For managing resource classifications.
• Resources V2 API: For managing individual resources.
• Staff Members API: For managing staff members.
• Schedules V3 API: For accessing business schedules directly.
• Events V3 API: For accessing events within schedules.

Key changes

• API separation: V1's single API is now split into specialized APIs for staff, resources, and resource types.
• Business resource elimination: Access business schedules and their events directly using the Calendar APIs with the fixed external ID 4e0579a5-491e-4e70-a872-d097eed6e520.
• Resource types: New formal classification system replaces V1's tag-based approach.
• Improved limits: Current APIs are much more generous than V1's 135 active + 135 deleted resource limit.

Accessing business schedule events

Instead of the V1 2-step process (query business resource → fetch schedule), you now have 2 options:

Option 1: Get schedule events

For most use cases, you'll want the actual events within the business schedule. Use Query Events with the externalScheduleId filter:

The business schedule includes only events of {"type": "WORKING_HOURS"}. The business is open during these hours and closed the rest of the time in the filtered range.

Option 2: Get schedule metadata only

Use Query Schedules with the fixed external ID. This returns the schedule entity but does not include events.

API reference mapping

Migration steps

Tp migrate your code, follow these steps:

1. Create resource types: Set up resource type templates using the Resource Types V2 API for consistent classification.
2. Migrate staff resources: Replace V1 staff queries (filtered by staff tag) with Staff Members API calls.
3. Migrate general resources: Replace V1 general resource queries (excluding staff and business tags) with Resources V2 API calls.
4. Update business schedule access: Replace the V1 business resource queries with direct Calendar API calls:
   • For schedule metadata: Use Schedules V3 Query Schedules with external ID 4e0579a5-491e-4e70-a872-d097eed6e520.
   • For schedule events: Use Events V3 Query Events with externalScheduleId filter and effective date filtering.
5. Test and validate: Run both APIs in parallel to ensure feature parity before fully switching.

Support

For migration assistance, follow these steps:

1. Check the API documentation:

   • Staff Members
   • Resources V2
   • Resource Types V2
   • Schedules V3
   • Events V3.

2. Review the Wix Bookings Calendar Integration Guide.

3. Contact Wix Developer Support for additional assistance.