v1.2

OpenAPI 3.1.1

magicplan Cloud API

Public API for magicplan customers

Server

https://cloud.magicplan.app/api/v2

Production System

Client Libraries

Shell Curl

Projects (Collapsed)

These endpoints allow for the creation, retrieval, updating, and deletion of projects in the system.

Projects Operations

get/projects
post/projects
put/projects
get/projects/{id}
put/projects/{id}
delete/projects/{id}
put/projects/{id}/archive
put/projects/{id}/restore
get/projects/{id}/plan

Project Files (Collapsed)

Endpoints for managing files associated with projects, including upload, registration, retrieval, and deletion.

Project Files Operations

post/projects/{id}/files/temporary-presigned-url
post/projects/{id}/files
get/projects/{id}/files
delete/projects/{id}/files/{fileId}

Estimates (Collapsed)

Endpoints for retrieving estimate-related information.

Estimates Operations

get/projects/{id}/estimates
get/projects/{id}/estimates/{estimateId}

Workspace (Collapsed)

Endpoints related to workspace management and configuration.

Workspace Operations

get/workspace
put/workspace
post/workspace/members/invite
delete/workspace/members

Teams (Collapsed)

Endpoints for managing and organizing teams and team-related activities.

Teams Operations

get/teams
post/teams
get/teams/{id}
put/teams/{id}
delete/teams/{id}
post/teams/{id}/members
delete/teams/{id}/members

Forms (Collapsed)

API for managing and retrieving forms withing your workspace, used for various data collection purposes.

Forms Operations

get/forms
post/forms
get/forms/{id}
put/forms/{id}
delete/forms/{id}

Plans (Collapsed)

Plan-centric endpoints for accessing, updating, and deleting plans.

Plans Operations

get/workgroups/plans
get/plans/get/{id}
delete/plans/{id}
get/plans/statistics/{id}
get/plans/forms/{id}
put/plans/{id}/owner
get/plans/{id}/files
post/plans/{id}/custom-export

Users (Collapsed)

Endpoints related to workspace users.

Users Operations

get/workgroups/users

Images (Collapsed)

These endpoints enable image loading.

Images Operations

get/images/plan/{id}/svg/{fileName}