The Projects API provides a suite of endpoints for managing the full lifecycle of your projects within the magicplan system. From creating new projects and retrieving existing ones, to updating project details, archiving them for safekeeping, and ultimately deleting them if needed, this API enables streamlined, programmatic control over your project data. Additionally, you can handle related files— such as floor plans, images, or other attachments—via pre-signed upload URLs and direct file registration.

Key CapabilitiesCopied!

• Lifecycle Management: Easily create new projects, fetch details of existing ones, update their information as scope changes, and archive or delete them when they’re no longer needed.

• Plan Retrieval: Access detailed project plans, including floor plans and spatial data, to support visualization, analysis, and reporting tasks.

• File Management: Securely upload and link files to projects using pre-signed URLs for authenticated, reliable file handling.

• Workflow Automation: Combine multiple endpoints to automate tasks. For example, automatically create a project when a property is listed, upload floor plan PDFs and related documents, gather user inputs, and later archive completed projects for a clean, organized workspace.

Who Should Use This API? Copied!

Developers and integrators who need to programmatically manage project data within their applications or services will find value in the Projects API. This includes:

• Real estate platforms integrating floor plan data into listings.

• Construction or remodeling services that track changes over the project’s lifecycle.

• Systems syncing project data with CRMs, ERPs, or analytics tools.

For detailed, step-by-step scenarios and best practices, see the examples on the following pages.