Migration Guide: v1 to v2

Important Timeline

Partner API v1 will be retired sometime in 2026 after a consultation period with our Partners. We strongly recommend starting your migration planning now to ensure a smooth transition.

Migration Guide Overview

This migration guide is split into three sections to help you navigate the transition:

What's New in v2

Discover the new features and improvements in Partner API v2, including:

• Enhanced device management capabilities
• Simplified patterns for resident engagement apps
• Upcoming features like resident challenges and gamification

Endpoint Comparison

Compare v1 and v2 endpoints to understand what's available:

• Available v2 endpoints you can migrate to immediately
• v1 endpoints that won't be available in v2
• Features that will be superseded with enhanced alternatives

Step-by-Step Migration

Follow our migration guide with detailed code examples.