Estimator API Endpoints – Coming Soon 🎉
We’re preparing two new API endpoints that will allow external systems to retrieve estimator data from magicplan projects. These endpoints are currently under development and this page provides an early preview of their structure and capabilities.
This documentation is a high-level draft and may change before the official release. Final specs and availability will be announced soon.
📌 Endpoints OverviewCopied!
1. GET /projects/{id}/estimatesCopied!
Returns a list of all estimates associated with a given project.
Response Example:
{
"data": [
{
"id": "ev65db22-6a24-4d8b-8219-10e591b34e82",
"name": "Kitchen Renovation Estimate",
"status": "draft",
"unique_id": "E202500001",
"created": "2025-04-11T07:30:03+00:00",
"modified": "2025-04-11T07:30:07+00:00"
}
],
"page_info": {
"totalCount": 1,
"page": 1,
"pageSize": 10,
"totalPages": 1
}
}
2. GET /projects/{id}/estimates/{estimateId}Copied!
Returns detailed information for a specific estimate.
-
Response Includes:
-
General estimate metadata (status, creator, timestamps, etc.)
-
Customer and company info
-
Associated project and address
-
A structured list of estimate items (with support for nested groups and line items)
-
Cost breakdowns and totals
-
-
Example data points:
-
Customer: name, contact, address, tax ID, etc.
-
Project: name, description, address
-
Estimate items: type, name, cost components, tax, and total values
-
Totals: subtotal, tax, total estimate value
-
Response Example:
{
"data": [
{
"id": "ev65db22-6a24-4d8b-8219-10e591b34e82",
"plan_id": "f1a1297a-5c42-4f2d-9877-4f4dc60718c2",
"name": "Kitchen Renovation Estimate",
"unique_identifier": "E202500016",
"creator": "John Smith",
"last_modifier": "Emily Johnson",
"status": "final",
"currency": "USD",
"date_issue": "2025-04-01 00:00:00",
"date_valid_until": "2025-12-31 00:00:00",
"created": "2025-03-15 10:00:00",
"modified": "2025-04-01 15:30:00",
"opening_statement": "Thank you for considering our services.",
"closing_statement": "We look forward to working with you.",
"customer": {
"id": "b34f3b7e-c762-4ae6-bca0-97485e0e27e9",
"firstname": "Alice",
"lastname": "Brown",
"company": "Brown Construction Ltd.",
"email": "alice.brown@example.com",
"phone": "+1-555-0123",
"fax": "+1-555-0124",
"tax_id": "TAX123456",
"address": "123 Maple Street",
"city": "Austin",
"zip": "73301",
"area": "Texas",
"country": "USA"
},
"project": {
"id": "33b618a7-e890-4f02-a163-688a2eb4d8d6",
"name": "Kitchen Makeover – Elm Street",
"description": "Full kitchen gut and remodel with modern finishes.",
"address": {
"id": "289dc03a-2fbf-4c2a-98de-4aa28a84270f",
"street": "456 Elm Street",
"city": "Austin",
"country": "USA",
"postal_code": 73301,
"latitude": "30.2672",
"longitude": "-97.7431"
}
},
"company": {
"id": "d1f9d5a0-85b5-4c92-acc5-bf4e3df91701",
"logo_url": "https://company-assets.example.com/logo.png",
"watermark_url": "https://company-assets.example.com/watermark.png",
"company": "Blueprint Solutions Ltd.",
"email": "info@blueprintsolutions.com",
"phone": "+1-555-9999",
"fax": "+1-555-8888",
"website": "https://blueprintsolutions.com",
"street": "789 Tech Park Blvd",
"city": "San Francisco",
"postal_code": "94105",
"country": "USA",
"province": "California"
},
"items": [
{
"id": "d4b8c3e3-991c-4fa6-8e14-bff7f2eebc80",
"parent_id": null,
"type": "position",
"code": "A100",
"name": "Demolition",
"description": "Remove old cabinets and flooring.",
"category": "Demolition",
"location": "Kitchen",
"internal_notes": "Requires debris removal plan.",
"quantity": 1,
"unit": "E",
"sort": 1,
"labor_unit_price": 500.000000000000,
"equipment_unit_price": 150.000000000000,
"material_unit_price": 0.000000000000,
"other_unit_price": 50.000000000000,
"labor_cost": 500.000000000000,
"equipment_cost": 150.000000000000,
"material_cost": 0.000000000000,
"other_cost": 50.000000000000,
"total_cost": 700.000000000000,
"markup": null,
"discount": null,
"tax": 0.190000000000,
"total": 833.000000000000,
"modified": "2025-04-01 13:00:00",
"created": "2025-03-15 10:05:00"
},
{
"id": "91c6d7c1-37f3-4f42-a274-9919a4ff8b6d",
"parent_id": null,
"type": "group",
"code": null,
"name": "Electrical Work",
"description": null,
"category": null,
"location": "Kitchen",
"internal_notes": null,
"quantity": null,
"unit": null,
"sort": 2,
"labor_unit_price": null,
"equipment_unit_price": null,
"material_unit_price": null,
"other_unit_price": null,
"labor_cost": null,
"equipment_cost": null,
"material_cost": null,
"other_cost": null,
"total_cost": null,
"markup": null,
"discount": null,
"tax": null,
"total": 1800.000000000000,
"modified": "2025-04-01 14:00:00",
"created": "2025-03-15 10:10:00"
},
{
"id": "aecb79f4-9bd6-4c6c-b038-1b34ffbcd290",
"parent_id": "91c6d7c1-37f3-4f42-a274-9919a4ff8b6d",
"type": "position",
"code": "E201",
"name": "Install lighting fixtures",
"description": "Includes recessed lights and under-cabinet lighting.",
"category": "Electrical",
"location": "Kitchen",
"internal_notes": null,
"quantity": 4,
"unit": "ft3",
"sort": 1,
"labor_unit_price": 100.000000000000,
"equipment_unit_price": 20.000000000000,
"material_unit_price": 75.000000000000,
"other_unit_price": 0.000000000000,
"labor_cost": 400.000000000000,
"equipment_cost": 80.000000000000,
"material_cost": 300.000000000000,
"other_cost": 0.000000000000,
"total_cost": 780.000000000000,
"markup": null,
"discount": null,
"tax": 0.190000000000,
"total": 928.200000000000,
"modified": "2025-04-01 14:10:00",
"created": "2025-03-15 10:12:00"
}
],
"estimate_totals": {
"equipment_costs_total": 230.000000000000,
"material_costs_total": 300.000000000000,
"labor_costs_total": 900.000000000000,
"other_costs_total": 50.000000000000,
"costs_total": 1480.000000000000,
"markup_total": 0.000000000000,
"discount_total": 0.000000000000,
"subtotal_without_tax": 1480.000000000000,
"tax_total": 281.200000000000,
"total": 1761.200000000000
}
}
]
}🔌 Integration Considerations
For teams preparing integration, we recommend:
-
Integrate the new endpoints into your existing system(s)
-
Handle nested JSON structures (especially for item groupings and totals)
-
Optionally persist or transform the data as needed for reporting, quoting, or financial workflows
-
Ensure appropriate error handling and authentication (our API is secured and uses standard auth flows)