magicplan

Retrieve the workspace custom-form answers captured on a plan, grouped by the symbol instance that carries them: forms with sections and fields, each field with id, label, and typed value. Only custom forms assigned on the Forms tab are included; for the built-in moisture-measurement series use get_moisture_readings. To locate a symbol in the building, match its symbol_instance_id against the uid of the objects in get_project_plan. Pass a plan ID from get_project (plan_id) or get_project_plan (id).

get_plan_forms

Retrieve a plan's measurement statistics, broken down by floor and room: floor and wall areas, opening (door/window) surface areas, ceiling height, volume, and object counts. furniture_count is the API count of freestanding and wall-attached objects, including objects outside the Furniture category in app Statistics. Describe it as an object count; use get_project_plan to identify individual objects when asked specifically about furniture. Ground areas are explicit: area_without_walls excludes all walls, area_with_interior_walls_only includes interior walls, and area_with_walls includes all walls. living_area follows the project living-area settings. Areas use square meters for metric units and square feet for imperial units. Pass a plan ID from get_project (plan_id) or get_project_plan (id).

get_plan_statistics

Retrieve details for a specific project, including its address, user, team, external reference, and plan_id.

get_project

Retrieve the field data recorded on the project's floor plan: the plan's custom attributes (for restoration, the claim details such as carrier, claim number, and type, category, and class of loss), and for each floor and room the entered field values and the placed objects, including equipment and affected-area annotations with their notes. Measurements are omitted here; use get_plan_statistics for areas and volumes.

get_project_plan

Orient on a project in one call: project details, the documentation per room (whether the room is affected by the loss, its photo count, and the number of moisture instruments placed, matched by symbol instance), the project's estimates with status, and the first page of scopes_of_work with page_info. Continue scopes with list_scopes_of_work. Rooms carry affected: true only when they contain an affected-area annotation, so an affected room with photos: 0 is a likely documentation gap. A room's photo count covers photos attached to the room or an object inside it (including affected-area annotations); photos attached at floor or plan level are not room-specific and appear only in list_project_photos, so the per-room counts can sum to less than its total_count. Drill down with get_project_plan (affected areas and captured field data), get_plan_statistics (measurements), list_project_photos, get_plan_forms, get_moisture_readings, list_project_files, get_estimate, and get_scope_of_work.

get_project_snapshot

Retrieve a scope of work and its document_positions, including groups and categories. Items carry parent_id, document_category_id, and sort for their hierarchy, plus sku, description, notes, calculated_quantity, and document_unit_symbol. reference identifies the location; match plan, floor, and room references with get_project_plan.

get_scope_of_work

Return one page of contents inventory items for a project, including room/object uid, box details, descriptions, quantities, categories and disposition. Follow page_info.next_page. Match object_uid with get_project_plan.

list_content_items

Returns one page of estimates associated with the specified project. Each estimate carries its name, status, identifier, and timestamps, alongside a page_info block.

list_estimates

Returns one page of documents and exports from the project Files tab, including Scoping Files and Photo Web Galleries. Each entry carries id, filename (the title for web galleries), filetype, url when available, timestamps, and tags identifying the export type. scope_of_work_export_pdf identifies a scoping PDF. A draft scope can already have exported PDFs. Web galleries are photo exports tagged photo_export_web (photo_export_tour360 for 360 tours), with a text/html filetype and the gallery URL; photo_export_pdf identifies a PDF photo export. Downloadable files also carry filesize. Follow page_info.next_page before concluding an export is missing. Internal capture files and individual photos/videos are excluded; use list_project_photos for those media.

list_project_files

Returns one page of project photos (including 360 photos) and videos. Excludes 3D autoscans, exports, thumbnails, and internal capture files. media_type identifies photo or video. page_info.total_count counts the matching photos and videos. Each entry carries id, model, foreign_key, filetype, caption, a directly fetchable URL when available, filesize, user_created, and attached_to_uid (match against uid in get_project_plan objects). The caption is the photographer's note and is often the only description of what the photo shows. Use page to continue and page_info to navigate. Use list_project_files for documents and exports.

list_project_photos

Returns one page of active projects in this workspace. Set include_archived to true to include archived projects as well. Filter by project name or assignee email, sort, and page through results. Each project carries its id, name, address, assignee, and timestamps, alongside a page_info block.

list_projects

Returns one page of scopes of work for a project, newest first, with id, name, status, project_id, plan_id, and timestamps. Use page_info to continue and get_scope_of_work for line items. For exported Scoping Files, use list_project_files; draft status does not mean that no PDF has been exported. Estimates are listed separately by list_estimates.

list_scopes_of_work

Remove items from a scope of work using the existing app deletion behavior.

remove_scope_of_work_items

Returns one page of line items from the workspace price lists that the app offers for the project. An item matches when every word of the query appears in its name, or when the query is part of its item code (SKU). Each item carries the id, sku, name, and document_unit_symbol to use with add_scope_of_work_items, alongside a page_info block.

search_library_items

Update supplied fields of a contents item. Omitted fields stay unchanged; null clears a field. Returns the saved item.

update_content_item

Change the location, quantity, or notes of items in a scope of work. Omitted fields stay unchanged. Returns the updated items.

update_scope_of_work_items

Return the magicplan workspace this connection is authenticated as.

get_workspace