GuideReferencemagicplan Cloud
  • Introduction to the magicplan REST API

  • Getting Started

    • Generating API Credentials

    • Authentication and Headers

    • Making Your First API Call

    • Network Requirements

  • Basic Concepts

    • Projects

      • Example 1: Creating and Preparing a Project

      • Example 2: Retrieving and Displaying Project Information

      • Example 3: Archiving and Deleting Projects

      • File Upload Guide

    • Plan Exchange XML Format

      • Plan

      • Floor

      • Exploded Floor

        • Wall

        • Door

        • Window

        • Furniture

      • Room

        • Point

        • Wide Opening

        • Door

        • Window

        • Furniture

      • Wires

      • Polygons

      • SymbolInstance

        • References

        • Values

        • Wall Items

        • Furniture

        • Floor

        • Plan

        • Room

        • Wall

        • Wire

        • Polygon

      • Standardized Plan Elements

        • Available types of floor

        • Predefined list of rooms

    • 3D Symbols

      • Pivot

      • Rotation

      • Size

      • Export

    • Estimator API Endpoints

    • Form API Endpoints

  • Advanced Integrations

    • OAuth 2.0

    • SSO

    • Deep Linking

    • Custom Export Button Integration

      • Webhook Documentation: Project Updated

      • Link Project

      • Authorize export from magicplan

      • Workflow Examples

        • Example 1: Automate File Processing with Webhooks

        • Example 2: Notify and Fetch Additional Files

        • Example 3: Multi-Step Workflow with Notifications

        • Example 4: Export and Sync with External Systems

        • Example 5: Export and Visualize

        • Example 6: Project Versioning Workflow

        • Example 7: Custom Forms Integration

  • FAQ

  • Changelog & Release Notes

  • Contact & Support

On This Page

  • File Upload Guide