magicplan offers several built-in integration options, but you can also use the magicplan REST API to seamlessly connect your platform with magicplan. The following sections will guide you through the various integration methods available.

What Can You Do with the API? Copied!

• Project & Plan Management: Create, retrieve, update, and delete projects and their associated plans.

• Workspaces & Teams: Manage user access, permissions, and collaboration within a workspace.

• Data Exports & Integrations: Automatically export plans and project data to other systems or formats for further processing.

Who Is It For?Copied!

The magicplan REST API is designed for developers, integrators, and technical leads who need to incorporate floor plan data, project organization, and workflow automation into their existing applications—such as real estate portals, construction management platforms, insurance claim systems, and interior design tools.

Before You BeginCopied!

• Basic Knowledge: Familiarity with RESTful APIs, JSON data formats, and HTTP request/response handling is recommended.

• Account & Credentials: Make sure you have a magicplan account with the appropriate access, and have obtained your API Key and Customer ID. Here you will learn how to generate your API Credentials.

Next StepsCopied!

• Getting Started: Head over to the Getting Started section to learn how to obtain credentials, authenticate your requests, and make your first API call.

• Explore Key Resources: Review documentation for Projects, Plan Exchange XML Format, and Workspace & Teams to understand the core operations.

• Advanced Integrations: Once you’re comfortable with the basics, explore advanced topics like the Custom Export Button, Webhook Documentation, or Deep Linking.

Reference Documentation Copied!

For detailed endpoint specifications, parameters, request/response models, and error codes, refer to the API Reference.