magicplan

Retrieve detailed information for a specific estimate in a project, including its line items, customer and company details, and cost totals.

get_estimate

Retrieve the drying-measurement history recorded on a plan's restoration instruments (moisture meters and ambient sensors). Returns one entry per instrument, localized to its floor and room, with a dated series of readings: moisture content, material and relative scale, air and surface temperature, relative humidity, and humidity ratio. Instruments placed but not yet read are included with an empty readings list, so a drying-documentation gap is visible rather than the instrument disappearing. This is the built-in per-symbol measurement series that get_plan_forms does not cover. Pass a plan ID from get_project (plan_id) or get_project_plan (id).

get_moisture_readings

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 door, window, and furniture counts. 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), and the project's estimates with status, newest first. 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, and get_estimate.

get_project_snapshot

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 files associated with a project (photos, PDFs, exports). Each file carries its id, filename, filetype, caption, a directly fetchable url, filesize, and what it is attached_to, alongside a page_info block.

list_project_files

Returns one page of project photos (excluding exports and thumbnails). Each entry carries id, filetype, caption, a directly fetchable URL, 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 non-image documents.

list_project_photos