AssetLab
Server Details
Work orders, PM schedules, assets, capital plans and infrastructure in AssetLab CMMS/EAM.
- Status
- Healthy
- Uptime
- 100.0% over the last 24 hours
- Last Tested
- Transport
- Streamable HTTP · MCP 2025-11-25
- URL
- ChatGPT
- –
- Claude
- –
TDQS
Scored across 481 tools
Each tool binds a specific resource and action (e.g. create_asset_cost vs create_expense vs create_infrastructure_asset_cost), and the descriptions explicitly call out the near-duplicates, including the facilities/infrastructure parallel families. However, the sheer number of parallel resource families (asset_documents vs attachments vs project_documents vs contract_documents; asset_part vs infrastructure_asset_part) means an agent must read descriptions carefully to avoid misselection.
The surface overwhelmingly follows a predictable verb_noun snake_case pattern (list_, get_, create_, update_, delete_ + resource), applied uniformly across hundreds of tools. Minor deviations exist: bulk_create/bulk_update put the verb first, and show_site_fci_trend, upload_file and create_upload_url sit outside the CRUD pattern.
481 tools is an extreme mismatch for any practical agent surface, far beyond the 3-15 typical range, and would overwhelm context and selection. Even if a handful of bulk_* tools cover some cross-resource work, per-resource CRUD expansion across ~60 entity types has produced a catalogue several orders of magnitude too large.
Coverage is broad and near-complete: most entities have full create/get/list/update/delete plus association-link tools, and lifecycle concepts (betterments, assessments, LoS targets, forms, purchase order lines) are modelled with dedicated endpoints. A few gaps remain, such as no update for composite-key junction links (contract_sites, vendor_site_assignments, project_assets) and no create/update path for system-generated history records.
Publisher details
- Operator
- AssetLab CMMS Software Inc. · Publisher source
- Operator website
- https://assetlab.ca
- Vendor relationship
- First-party
- Documentation
- https://app.assetlab.ca/docs/ai
- Privacy policy
- Not provided
- Trust center
- https://assetlab.ca/trust
- Restrictions
- Requires an AssetLab Enterprise plan. Authentication uses an AssetLab API key created in Settings > API Keys, sent as a Bearer token or exchanged through the OAuth flow; the key's scopes limit which tools are available. Customer data is stored in Canada, but the MCP endpoint runs on Cloudflare's global edge, generally outside Canada.
Available Tools
481 toolsbulk_createBulk createAInspect
Create multiple records of a resource type in one API call (max 100). Each item is processed independently - one failure does not affect others. Returns per-item results. Requires {resource}:write scope. Counts as 1 request for rate limiting. Writes only: to read many records use list_ (e.g. list_assets), which returns every page.
Inputs: items (required), resource (required).
bulk_updateBulk updateADestructiveIdempotentInspect
Update multiple records of a resource type in one API call (max 100). Each item must include an "id" field (UUID). Each item is processed independently - one failure does not affect others. Returns per-item results. Requires {resource}:write scope. Counts as 1 request for rate limiting. Writes only: to read many records use list_ (e.g. list_assets), which returns every page.
Inputs: items (required), resource (required).
create_assetCreate assetAInspect
Create a new asset. Requires assets:write scope. IMPORTANT - Location hierarchy: always resolve top-down by calling list_sites first, then list_buildings filtered by site_id, then list_locations filtered by building_id. Provide all three IDs (site_id, building_id, location_id) explicitly. System hierarchy: similarly resolve via list_system_classes → list_system_groups → list_systems.
Inputs: name (required), model, site_id, asset_id, +35 more.
create_asset_bettermentCreate asset bettermentAInspect
Record capital work that ALREADY extended a facility asset's life - an elevator modernization, a boiler retube, a major component replacement. Required: asset_id and occurred_on; capitalized_amount and added_life_years are optional and may be 0. The asset's net book value and remaining life re-base from occurred_on, and its purchase_date is NEVER changed - if a user asks to change an in-service date to reflect an overhaul, record this instead and say why. Use asset_lifecycle_events for work expected in future; use a condition assessment for what someone observed. Call list_assets first to resolve asset_id. Requires asset_betterments:write scope.
Inputs: asset_id (required), occurred_on (required), project_id, description, +5 more.
create_asset_commentCreate asset commentAInspect
Create a new comment on an asset. Requires asset_comments:write scope.
Inputs: comment (required), asset_id (required).
create_asset_condition_assessmentCreate asset condition assessmentAInspect
Record a point-in-time condition assessment against an asset. Requires asset_condition_assessments:write scope. Call list_assets first to resolve asset_id.
Inputs: asset_id (required), assessed_on (required), notes, method, +5 more.
create_asset_costCreate asset costAInspect
Create a new asset cost entry - the record type shown on the AssetLab "Expenses" page. Requires asset_costs:write scope.
Inputs: amount (required), category (required), cost_date (required), site_id, +8 more.
create_asset_documentCreate asset documentAInspect
Create an asset document record (after uploading the file via create_upload_url). Requires asset_documents:write scope.
Inputs: name (required), asset_id (required), file_path (required), user_id, +4 more.
create_asset_lifecycle_eventCreate asset lifecycle eventAInspect
Create a facility lifecycle strategy event. Events attach to an asset-type SCOPE - exactly ONE of asset_type_id or asset_type_group_id - never to individual assets; an asset resolves its type's own strategy first, else its type group's. Replacement is NOT an event (it stays the renewal forecast + replacement value) - model the interventions BEFORE replacement: roof recoats, boiler retubes, overhauls. Resolve type ids with list_asset_types / list_asset_type_groups, and list existing events first to reuse a scope. Requires asset_lifecycle_events:write scope.
Inputs: name (required), event_class (required), impact_method (required), trigger_condition_max (required), +13 more.
create_asset_partCreate asset partAInspect
Link a part to an asset (creates an asset-part association). Requires asset_parts:write scope.
Inputs: part_id (required), asset_id (required), quantity.
create_asset_placementCreate asset placementAInspect
Place an asset on a floorplan at the given (x, y) coordinate (normalized 0-1, origin top-left). UPSERTS by asset_id - an asset can have at most ONE placement globally, so calling this again just moves the pin. Use bulk_create with resource="asset-placements" to place many assets at once. Requires asset_placements:write scope.
Inputs: x (required), y (required), asset_id (required), floorplan_id (required), +2 more.
create_asset_replacement_planCreate asset replacement planBInspect
Create a new asset replacement plan. Requires asset_replacement_plans:write scope.
Inputs: asset_id (required), planned_replacement_year (required), notes, status, +3 more.
create_asset_statusCreate asset statusAInspect
Create a new asset status (lifecycle state for assets). Requires asset_statuses:write scope.
Inputs: name (required), color, module, description.
create_asset_typeCreate asset typeBInspect
Create a new asset type. Requires asset_types:write scope.
Inputs: name (required), group_id, description.
create_asset_type_groupCreate asset type groupAInspect
Create a new asset type group. Groups organize asset types into logical categories. Requires asset_type_groups:write scope.
Inputs: name (required), color, description.
create_attachmentCreate attachmentAInspect
Create an attachment record linked to a work order, work request, PM schedule, or PM template. Exactly one parent ID must be provided. Requires attachments:write scope.
Inputs: file_url (required), file_name (required), file_size, file_type, +6 more.
create_budgetCreate budgetAInspect
Set an annual funding budget, as the dashboard Budget tab does. Requires budgets:write scope. The tab holds one figure per year, per funding source ('O&M' or 'Capital'), per workspace (module: facilities, infrastructure, or omitted for organization-wide). Send one row per year and funding source - do not split a year across sites or buildings; the tab does not read site_id or building_id and a second row for the same slot is refused with 409. Required: year, funding_source, budgeted_amount.
Inputs: year (required), funding_source (required), module, site_id, +3 more.
create_buildingCreate buildingAInspect
Create a new building. Requires buildings:write scope. latitude and longitude place the building on the map and must be sent together - one without the other is rejected.
Inputs: name (required), site_id (required), type, floors, +5 more.
create_building_typeCreate building typeBInspect
Create a new building type. Requires building_types:write scope.
Inputs: name (required), description.
create_change_orderCreate change orderBInspect
Create a new change order. Requires change_orders:write scope.
Inputs: amount (required), co_number (required), project_id (required), description (required), +5 more.
create_compliance_itemCreate compliance itemBInspect
Create a new compliance item (regulatory requirement). Requires compliance:write scope.
Inputs: name (required), status, system_id, description, +2 more.
create_compliance_pm_scheduleCreate compliance PM scheduleAInspect
Link a PM schedule to a compliance item, so completing the schedule keeps the item compliant. Requires compliance:write scope. Required: compliance_item_id, pm_schedule_id, required_frequency_days. Resolve both ids first with list_compliance_items and list_pm_schedules.
Inputs: pm_schedule_id (required), compliance_item_id (required), required_frequency_days (required), weight.
create_compliance_recordCreate compliance recordBInspect
Create a new compliance record (audit trail entry). Requires compliance_records:write scope.
Inputs: completed_at (required), work_order_id (required), pm_schedule_id (required), compliance_item_id (required), +3 more.
create_contractCreate contractBInspect
Create a new contract. Requires contracts:write scope.
Inputs: title (required), category (required), end_date (required), start_date (required), +6 more.
create_contract_documentCreate contract documentBInspect
Create a contract document record. Requires contract_documents:write scope.
Inputs: file_name (required), file_path (required), contract_id (required), file_size, +2 more.
create_contract_siteCreate contract siteAInspect
Assign a contract to a site. Requires contract_sites:write scope.
Inputs: site_id (required), contract_id (required).
create_cost_categoryCreate cost categoryAInspect
Create a new cost category. Requires cost_categories:write scope.
Inputs: name (required), is_active, parent_id.
create_criticality_modifierCreate criticality modifierAInspect
Override the criticality modifier for one tier. Rows are overrides only: a tier with no row uses the built-in default (critical 0.6, high 0.8, medium 1.0, low 1.4). A modifier below 1 tightens every target held by facilities in that tier and one above 1 relaxes them. One override per tier; a duplicate returns 409, so call list_criticality_modifiers and update the existing row instead. Requires los_targets:write scope.
Inputs: modifier (required), criticality (required).
create_custom_field_definitionCreate custom field definitionAInspect
Create a new custom field definition. Requires custom_fields:write scope.
Inputs: field_name (required), field_type (required), entity_type (required), field_label, +3 more.
create_custom_field_valueCreate custom field valueBInspect
Create (upsert) a custom field value for an entity. The table stores values in typed columns - prefer setting the one that matches the field definition's field_type: value_text (text/select; a select value must be one of the field's options), value_number (number), value_date (date, ISO YYYY-MM-DD), value_boolean (boolean). Alternatively pass a single value string and the server will dispatch it to the right column based on field_type. Writes upsert on (entity_id, field_definition_id) so replaying a batch is idempotent. Requires custom_fields:write scope.
Inputs: entity_id (required), field_definition_id (required), value, value_date, +3 more.
create_expenseCreate expenseBInspect
Create a new expense. Requires expenses:write scope.
Inputs: amount (required), project_id (required), description (required), expense_date (required), +4 more.
create_floorplanCreate floorplanAInspect
Create a floorplan row. Provide EXACTLY ONE of building_id (per-building floor) or site_id (site-level / campus plan). Typically the web app calls this per page of an uploaded PDF; MCP clients rarely need to call this directly since they do not upload the PDF itself. Requires floorplans:write scope.
Inputs: floor_label (required), pdf_filename (required), pdf_storage_path (required), status, +6 more.
create_floorplan_regionCreate floorplan regionAInspect
Create a region (labeled room or zone) on a floorplan. Polygon coordinates are normalized 0-1 with origin top-left. Optionally link the region to an existing Location via location_id. Requires floorplan_regions:write scope.
Inputs: label (required), polygon (required), floorplan_id (required), source, +3 more.
create_form_responseCreate form responseAInspect
Attach a published form to one record so it can be filled in - the direct way to put an inspection or checklist on an existing work order. The form's questions are snapshotted at attach time, so later edits to the template never change a form already in progress. To put a form on every work order a PM schedule generates, set form_template_id on the schedule instead of calling this per work order. Answering and completing the form happen in the AssetLab app, not through this API. Requires form_responses:write scope.
Inputs: subject_id (required), template_id (required), subject_type (required).
create_form_templateCreate form templateAInspect
Create a form template - a reusable inspection, checklist, compliance, or survey definition. Step 1 of building a form: create it as a draft, then add questions with create_form_template_item (or bulk_create on form-template-items), then publish with update_form_template status=published (publishing is rejected if any question is malformed). Requires form_templates:write scope.
Inputs: name (required), module, status, description, +1 more.
create_form_template_itemCreate form template itemAInspect
Add one question (item) to a form template. Build a form by calling this once per question in order, or use bulk_create on form-template-items. Requires form_template_items:write scope.
Inputs: label (required), item_type (required), sort_order (required), template_id (required), +6 more.
create_infrastructure_assetCreate infrastructure assetAInspect
Create an infrastructure asset (feature - segment or node). Geometry must be GeoJSON Point (for nodes) or LineString (for segments) in EPSG:4326; coordinates are [longitude, latitude]. length_m, slope_pct, and risk_score are computed server-side. Requires infrastructure_assets:write scope.
Inputs: geometry (required), network_id (required), feature_type (required), name, +52 more.
create_infrastructure_asset_commentCreate infrastructure asset commentAInspect
Add a comment to an infrastructure feature. The author is set automatically; do not pass user_id. Requires infrastructure_asset_comments:write scope.
Inputs: comment (required), feature_id (required).
create_infrastructure_asset_costCreate infrastructure asset costAInspect
Record a cost against an infrastructure feature. work_order_number is derived server-side from work_order_id; do not set it. Requires infrastructure_asset_costs:write scope.
Inputs: amount (required), category (required), cost_date (required), feature_id (required), +5 more.
create_infrastructure_asset_documentCreate infrastructure asset documentAInspect
Attach document metadata to an infrastructure feature. Upload the file bytes first via create_upload_url, then pass the returned file_path here. Requires infrastructure_asset_documents:write scope.
Inputs: name (required), file_path (required), feature_id (required), category, +3 more.
create_infrastructure_asset_inspectionCreate infrastructure asset inspectionBInspect
Record an inspection against an infrastructure feature. Requires infrastructure_asset_inspections:write scope.
Inputs: feature_id (required), inspection_date (required), notes, method, +4 more.
create_infrastructure_asset_partCreate infrastructure asset partAInspect
Associate a part with an infrastructure feature. The (feature_id, part_id) pair must be unique - a duplicate returns 409. Requires infrastructure_asset_parts:write scope.
Inputs: part_id (required), feature_id (required), quantity.
create_infrastructure_feature_classCreate infrastructure feature classAInspect
Create a tenant-defined infrastructure feature class. Builtin classes are managed by AssetLab and cannot be created via API (is_builtin is always forced to false). Requires infrastructure_feature_classes:write scope.
Inputs: code (required), label (required), category (required), icon, +2 more.
create_infrastructure_lifecycle_eventCreate infrastructure lifecycle eventAInspect
Create a lifecycle strategy event. Events attach to a SCOPE (feature_class code, material, optional diameter band) - never to individual features; every feature resolves the most specific matching scope, like replacement rates. Replacement is NOT an event (it is priced by the rates and scheduled by the renewal forecast) - model the interventions BEFORE replacement: crack sealing, relining, resurfacing. List existing events first to reuse a scope. Requires infrastructure_lifecycle_events:write scope.
Inputs: name (required), event_class (required), impact_method (required), trigger_condition_max (required), +16 more.
create_infrastructure_los_targetCreate infrastructure LoS targetAInspect
Set the technical Level of Service target for one infrastructure feature class and metric. One base target per feature class and metric, set once for the organization; a duplicate returns 409, so update the existing row instead. Each network of that class is held to a version adjusted by the network's criticality (unrated counts as medium): a lower-is-better target is multiplied by the tier's modifier, a higher-is-better one keeps its distance from a perfect score multiplied by it (condition 70 becomes 82 at a Critical network, 58 at a Low one). Derived targets never leave the metric's scale. All three metrics run 0-100: asset_condition_avg is higher-is-better and uses the fixed condition bands; fci and asset_past_useful_life_pct are percentages, lower-is-better. Average risk is not available for infrastructure. Not money. Requires los_targets:write scope, and the organization's plan must include both Level of Service and Infrastructure. Resolve feature_class first via list_infrastructure_feature_classes.
Inputs: metric (required), base_target (required), feature_class (required), active.
create_infrastructure_networkCreate infrastructure networkAInspect
Create an infrastructure network - a named grouping of features bound to one feature class. Requires infrastructure_networks:write scope.
Inputs: name (required), feature_class (required), metadata, criticality, +2 more.
create_infrastructure_zoneCreate infrastructure zoneAInspect
Create an operational hydraulic boundary (pressure zone, DMA, sewershed, etc.). boundary is a GeoJSON Polygon, or a MultiPolygon when the area comes in separate pieces. (network_id, name) must be unique. Requires infrastructure_zones:write scope.
Inputs: kind (required), name (required), boundary (required), network_id (required), +2 more.
create_invoiceCreate invoiceBInspect
Create a new invoice. Requires invoices:write scope.
Inputs: amount (required), invoice_date (required), invoice_number (required), notes, +10 more.
create_locationCreate locationAInspect
Create a new location within a building. Requires locations:write scope.
Inputs: name (required), building_id (required), area, type, +2 more.
create_location_typeCreate location typeBInspect
Create a new location type. Requires location_types:write scope.
Inputs: name (required), description.
create_los_consequenceCreate LoS consequenceAInspect
Record what a missed technical Level of Service target means, in the organization's own words. Advisory only: the statement is shown on the Status screen when a matching target is breached, and no notification is sent to notify_roles or to anyone else. When several match a breach the most specific scope wins (a specific system or feature class over a criticality tier over global). severity is a floor; the severity shown scales with the size of the gap and the facility's criticality. Requires los_consequences:write scope.
Inputs: severity (required), statement (required), scope_type (required), active, +3 more.
create_los_measureCreate LoS measureAInspect
Create a new LoS measure within a service area. Requires los_measures:write scope. Resolve service_area_id first via list_service_areas.
Inputs: name (required), type (required), category (required), data_source (required), +12 more.
create_los_measurementCreate LoS measurementAInspect
Record a new LoS measurement value. Requires los_measurements:write scope. Resolve los_measure_id first via list_los_measures.
Inputs: period_end (required), period_type (required), actual_value (required), period_start (required), +3 more.
create_los_proposed_targetCreate LoS proposed targetAInspect
Record the proposed level of service for a LoS measure in one future year (O. Reg. 588/17 s. 6(1)). One row per measure and year; a duplicate returns 409, so update the existing row instead. Use target_statement for a community measure and target_value for a technical one. Requires los_proposed_targets:write scope. Resolve los_measure_id first via list_los_measures.
Inputs: year (required), los_measure_id (required), target_value, target_statement.
create_manufacturerCreate manufacturerBInspect
Create a new manufacturer. Requires manufacturers:write scope.
Inputs: name (required), notes, website, contact_name, +2 more.
create_partCreate partBInspect
Create a new part/inventory item. Requires parts:write scope.
Inputs: name (required), cost, site_id, category, +8 more.
create_part_categoryCreate part categoryBInspect
Create a new part category. Requires part_categories:write scope.
Inputs: name (required), module, description.
create_pm_scheduleCreate PM scheduleBInspect
Create a new preventive maintenance schedule. Requires pm_schedules:write scope. IMPORTANT - Location hierarchy: always resolve top-down by calling list_sites first, then list_buildings filtered by site_id, then list_locations filtered by building_id. Provide all three IDs explicitly.
Inputs: title (required), tasks, status, site_id, +27 more.
create_pm_templateCreate PM templateAInspect
Create a new PM template. Templates are reusable PM definitions (not linked to a site/asset) that can seed new PM schedules. Requires pm_templates:write scope.
Inputs: title (required), tasks, priority, asset_ids, +12 more.
create_projectCreate projectBInspect
Create a new project. Requires projects:write scope.
Inputs: name (required), start_date (required), budget, status, +11 more.
create_project_assetCreate project assetAInspect
Link an asset to a project. Requires project_assets:write scope.
Inputs: asset_id (required), project_id (required).
create_project_budget_itemCreate project budget itemBInspect
Create a new project budget item. Requires project_budget_items:write scope.
Inputs: category (required), project_id (required), notes, description, +2 more.
create_project_buildingCreate project buildingAInspect
Link a building to a project. Requires project_buildings:write scope.
Inputs: project_id (required), building_id (required).
create_project_commentCreate project commentBInspect
Create a new comment on a project. Requires project_comments:write scope.
Inputs: content (required), project_id (required), parent_id.
create_project_cost_snapshotCreate project cost snapshotAInspect
Record a cost snapshot for a project at a point in time. Requires project_cost_snapshots:write scope.
Inputs: project_id (required), actual_cost (required), total_budget (required), snapshot_date (required), +2 more.
create_project_documentCreate project documentBInspect
Create a project document record. Requires project_documents:write scope.
Inputs: name (required), file_path (required), project_id (required), uploaded_by (required), +4 more.
create_project_document_folder_templateCreate project document folder templateBInspect
Create a project document folder template. Requires project_document_folder_templates:write scope.
Inputs: name (required), structure, is_default, description.
create_project_infrastructure_assetCreate project infrastructure assetAInspect
Link a project to an infrastructure feature. The (project_id, feature_id) pair must be unique - a duplicate returns 409. Requires project_infrastructure_assets:write scope.
Inputs: feature_id (required), project_id (required), notes.
create_project_locationCreate project locationBInspect
Link a location to a project. Requires project_locations:write scope.
Inputs: project_id (required), location_id (required).
create_project_milestoneCreate project milestoneBInspect
Create a new project milestone. Requires project_milestones:write scope.
Inputs: name (required), due_date (required), project_id (required), status, +4 more.
create_project_phaseCreate project phaseAInspect
Create a new project phase. Requires project_phases:write scope.
Inputs: name (required), project_id (required), status, end_date, +3 more.
create_project_phase_categoryCreate project phase categoryBInspect
Create a new project phase category. Requires project_phase_categories:write scope.
Inputs: name (required), sort_order, description.
create_project_riskCreate project riskBInspect
Create a new project risk. Requires project_risks:write scope.
Inputs: title (required), project_id (required), impact, status, +8 more.
create_project_siteCreate project siteAInspect
Link a site to a project. Requires project_sites:write scope.
Inputs: site_id (required), project_id (required).
create_project_systemCreate project systemBInspect
Link a system to a project. Requires project_systems:write scope.
Inputs: system_id (required), project_id (required).
create_project_system_classCreate project system classAInspect
Link a system class to a project. Requires project_system_classes:write scope.
Inputs: project_id (required), system_class_id (required).
create_project_system_groupCreate project system groupAInspect
Link a system group to a project. Requires project_system_groups:write scope.
Inputs: project_id (required), system_group_id (required).
create_project_taskCreate project taskBInspect
Create a new project task. Requires project_tasks:write scope.
Inputs: title (required), project_id (required), status, due_date, +9 more.
create_project_task_dependencyCreate project task dependencyBInspect
Create a dependency between two project tasks. Requires project_task_dependencies:write scope.
Inputs: task_id (required), depends_on_task_id (required), dependency_type.
create_project_team_memberCreate project team memberBInspect
Add a team member to a project. Requires project_team_members:write scope.
Inputs: role (required), user_id (required), project_id (required), end_date, +3 more.
create_project_time_entryCreate project time entryBInspect
Create a new project time entry. Requires project_time_entries:write scope.
Inputs: task_id (required), user_id (required), project_id (required), start_time (required), +5 more.
create_project_updateCreate project updateBInspect
Create a periodic project status update. Requires project_updates:write scope.
Inputs: content (required), author_id (required), timeframe (required), project_id (required), +3 more.
create_purchase_orderCreate purchase orderBInspect
Create a new purchase order. Requires purchase_orders:write scope.
Inputs: amount (required), po_number (required), notes, status, +7 more.
create_purchase_order_lineCreate purchase order lineAInspect
Add a line item to a purchase order. Requires purchase_orders:write scope. The PO's amount becomes the sum of its lines. A line naming a part_id is counted in whole units, and its quantity_received is added to that part's stock. Required: purchase_order_id, description, quantity.
Inputs: quantity (required), description (required), purchase_order_id (required), part_id, +3 more.
create_purchase_order_linkCreate purchase order linkAInspect
Link a purchase order to a work order, PM schedule or project for reference. Requires purchase_orders:write scope. Required: purchase_order_id and exactly one of work_order_id, pm_schedule_id, project_id. A link does not add to committed cost; to charge the cost, set project_id or work_order_id on the purchase order itself.
Inputs: purchase_order_id (required), project_id, work_order_id, pm_schedule_id.
create_service_areaCreate service areaAInspect
Create a new service area for Level of Service tracking. Requires service_areas:write scope. After creating, link system classes via create_service_area_system_class and sites via create_service_area_site.
Inputs: name (required), icon, color, is_active, +2 more.
create_service_area_siteCreate service area siteAInspect
Link a site to a service area (optional scoping). Requires service_areas:write scope. Resolve IDs first: list_service_areas → service_area_id, list_sites → site_id.
Inputs: site_id (required), service_area_id (required).
create_service_area_system_classCreate service area system classAInspect
Link a system class to a service area. Requires service_areas:write scope. Resolve IDs first: list_service_areas → service_area_id, list_system_classes → system_class_id.
Inputs: service_area_id (required), system_class_id (required).
create_siteCreate siteBInspect
Create a new site. Requires sites:write scope.
Inputs: name (required), city, address, country, +23 more.
create_systemCreate systemBInspect
Create a new system. Requires systems:write scope.
Inputs: name (required), description, crv_multiplier, system_group_id.
create_system_classCreate system classAInspect
Create a new system class (top-level classification, e.g., "HVAC & Mechanical", "Material Handling"). Requires systems:write scope.
Inputs: name (required), description.
create_system_groupCreate system groupAInspect
Create a new system group (category under a system class, e.g., "Heating", "Cooling"). Requires systems:write scope.
Inputs: name (required), description, system_class_id.
create_system_los_targetCreate system LoS targetAInspect
Set the technical Level of Service target for one system and metric. One base target per system and metric, set once for the organization; a duplicate returns 409, so update the existing row instead. Each building is held to a version adjusted by its criticality: a lower-is-better target is multiplied by the tier's modifier, a higher-is-better one keeps its distance from a perfect score multiplied by it (condition 70 becomes 82 at a Critical facility, 58 at a Low one). Derived targets never leave the metric's scale. Direction is fixed by the metric and cannot be sent: asset_condition_avg is higher-is-better and uses the fixed 0-100 condition bands; fci, asset_past_useful_life_pct (both 0-100 percent) and risk_score_avg (0-25) are lower-is-better. Not money. Requires los_targets:write scope. Resolve system_id first via list_systems.
Inputs: metric (required), system_id (required), base_target (required), active.
create_upload_urlCreate upload URLAInspect
Generate a signed upload URL for uploading a file to AssetLab storage. Returns a signed_url to PUT the file to, and the storage path to store on the record. IMPORTANT - When a user wants to upload a file, always clarify the target. File upload paths: (1) Asset IMAGE: bucket "asset-images" → update_asset with image_url. (2) Asset DOCUMENT (O&M, warranty, spec): bucket "documents" → create_asset_document. (3) Work order IMAGE: bucket "attachments" → update_work_order with image_url. (4) Work order/request/PM ATTACHMENT: bucket "attachments" → create_attachment with the parent ID. (5) Project DOCUMENT: bucket "project-documents" → create_project_document. (6) Contract DOCUMENT: bucket "contract-documents" → create_contract_document. Always ask the user which type they mean if ambiguous. Requires upload_urls:write scope.
Inputs: bucket (required), file_name (required).
create_vendorCreate vendorAInspect
Create a new vendor. Requires vendors:write scope.
Inputs: name (required), city, state, status, +8 more.
create_vendor_site_assignmentCreate vendor site assignmentBInspect
Assign a vendor to a site. Requires vendor_site_assignments:write scope.
Inputs: site_id (required), vendor_id (required).
create_work_categoryCreate work categoryBInspect
Create a new work category. Requires work_categories:write scope.
Inputs: name (required), module, description.
create_work_orderCreate work orderAInspect
Create a new work order. Requires work_orders:write scope. REQUIRED: title. STRONGLY RECOMMENDED: site_id, building_id and at least one target (asset_id, location_id, system_ids or infrastructure_asset_ids) - the AssetLab app always sets one, and a work order with no target is hard to find and to cost, so ask the user which applies before calling. The API accepts a work order without a target. Also recommended: work_category_id (look up via list_work_categories; omit only if no reasonable match exists). Location hierarchy: always resolve top-down by calling list_sites first, then list_buildings filtered by site_id, then list_locations filtered by building_id.
Inputs: title (required), type, status, site_id, +20 more.
create_work_order_commentCreate work order commentAInspect
Create a new comment on a work order. Requires work_order_comments:write scope.
Inputs: comment (required), work_order_id (required).
create_work_order_scheduleCreate work order scheduleAInspect
Schedule a work order for a technician on a date (one entry of a day plan). stop_order gives the position in the technician's day; leave it unset for an unordered calendar entry. Requires work_order_schedules:write scope.
Inputs: technician_id (required), work_order_id (required), scheduled_date (required), stop_order, +5 more.
create_work_requestCreate work requestAInspect
Create a new work request. Requires work_requests:write scope. IMPORTANT - Location hierarchy: always resolve top-down by calling list_sites first, then list_buildings filtered by site_id, then list_locations filtered by building_id. Provide all three IDs (site_id, building_id, location_id) explicitly.
Inputs: title (required), status, site_id, asset_id, +6 more.
delete_assetDelete assetADestructiveIdempotentInspect
Permanently delete an asset by ID, cascading to its history. Requires assets:write scope. For an asset taken out of service, archive it instead with update_asset (status_id = the Archived status), which keeps its work orders, costs and inspections.
Inputs: id (required).
delete_asset_bettermentDelete asset bettermentADestructiveIdempotentInspect
Delete a betterment by ID. The asset's net book value and remaining life revert to what they were without it. Requires asset_betterments:write scope.
Inputs: id (required).
delete_asset_commentDelete asset commentADestructiveIdempotentInspect
Delete an asset comment by ID. Requires asset_comments:write scope.
Inputs: id (required).
delete_asset_condition_assessmentDelete asset condition assessmentADestructiveIdempotentInspect
Soft-delete an asset condition assessment by ID. Requires asset_condition_assessments:write scope.
Inputs: id (required).
delete_asset_costDelete asset costBDestructiveIdempotentInspect
Delete an asset cost entry by ID. Requires asset_costs:write scope.
Inputs: id (required).
delete_asset_documentDelete asset documentADestructiveIdempotentInspect
Delete an asset document by ID. Requires asset_documents:write scope.
Inputs: id (required).
delete_asset_lifecycle_eventDelete asset lifecycle eventADestructiveIdempotentInspect
Delete a facility lifecycle strategy event by ID. Projections recompute immediately; consider update with is_active=false to disable instead. Requires asset_lifecycle_events:write scope.
Inputs: id (required).
delete_asset_partDelete asset partADestructiveIdempotentInspect
Remove a part from an asset by association ID. Requires asset_parts:write scope.
Inputs: id (required).
delete_asset_placementDelete asset placementADestructiveIdempotentInspect
Remove an asset placement. The asset itself is not affected - only the pin on the floorplan is removed. Requires asset_placements:write scope.
Inputs: id (required).
delete_asset_replacement_planDelete asset replacement planBDestructiveIdempotentInspect
Delete an asset replacement plan by ID. Requires asset_replacement_plans:write scope.
Inputs: id (required).
delete_asset_statusDelete asset statusADestructiveIdempotentInspect
Delete an asset status by ID. Requires asset_statuses:write scope. The built-in Archived status (system_key archived) cannot be deleted.
Inputs: id (required).
delete_asset_typeDelete asset typeBDestructiveIdempotentInspect
Delete an asset type by ID. Requires asset_types:write scope.
Inputs: id (required).
delete_asset_type_groupDelete asset type groupADestructiveIdempotentInspect
Delete an asset type group by ID. Requires asset_type_groups:write scope.
Inputs: id (required).
delete_attachmentDelete attachmentBDestructiveIdempotentInspect
Delete an attachment by ID. Requires attachments:write scope.
Inputs: id (required).
delete_budgetDelete budgetBDestructiveIdempotentInspect
Delete a budget by ID. Requires budgets:write scope.
Inputs: id (required).
delete_buildingDelete buildingADestructiveIdempotentInspect
Delete a building by ID. Requires buildings:write scope.
Inputs: id (required).
delete_building_typeDelete building typeADestructiveIdempotentInspect
Delete a building type by ID. Requires building_types:write scope.
Inputs: id (required).
delete_change_orderDelete change orderADestructiveIdempotentInspect
Delete a change order by ID. Requires change_orders:write scope.
Inputs: id (required).
delete_compliance_itemDelete compliance itemADestructiveIdempotentInspect
Delete a compliance item by ID. Requires compliance:write scope.
Inputs: id (required).
delete_compliance_pm_scheduleDelete compliance PM scheduleADestructiveIdempotentInspect
Unlink a PM schedule from a compliance item. The schedule and the item both stay. Requires compliance:write scope.
Inputs: id (required).
delete_compliance_recordDelete compliance recordADestructiveIdempotentInspect
Delete a compliance record by ID. Requires compliance_records:write scope.
Inputs: id (required).
delete_contractDelete contractBDestructiveIdempotentInspect
Delete a contract by ID. Requires contracts:write scope.
Inputs: id (required).
delete_contract_documentDelete contract documentADestructiveIdempotentInspect
Delete a contract document by ID. Requires contract_documents:write scope.
Inputs: id (required).
delete_contract_siteDelete contract siteADestructiveIdempotentInspect
Remove a contract from a site. Requires contract_sites:write scope. An assignment is identified by its contract and site; it has no id of its own.
Inputs: site_id (required), contract_id (required).
delete_cost_categoryDelete cost categoryADestructiveIdempotentInspect
Delete a cost category by ID. Requires cost_categories:write scope.
Inputs: id (required).
delete_criticality_modifierDelete criticality modifierADestructiveIdempotentInspect
Delete a criticality modifier override by ID, which restores the built-in default for that tier (critical 0.6, high 0.8, medium 1.0, low 1.4). Requires los_targets:write scope.
Inputs: id (required).
delete_custom_field_definitionDelete custom field definitionBDestructiveIdempotentInspect
Delete a custom field definition by ID. Requires custom_fields:write scope.
Inputs: id (required).
delete_custom_field_valueDelete custom field valueADestructiveIdempotentInspect
Delete a custom field value by ID. Requires custom_fields:write scope.
Inputs: id (required).
delete_expenseDelete expenseADestructiveIdempotentInspect
Delete an expense by ID. Requires expenses:write scope.
Inputs: id (required).
delete_floorplanDelete floorplanADestructiveIdempotentInspect
Delete a floorplan. WARNING: cascades to all regions and asset placements on this floor. Does NOT delete the underlying PDF file from storage (do that separately if no other floors reference it). Requires floorplans:write scope.
Inputs: id (required).
delete_floorplan_regionDelete floorplan regionADestructiveIdempotentInspect
Delete a region. Asset placements that referenced this region will have region_id set to null but remain on the floorplan. Requires floorplan_regions:write scope.
Inputs: id (required).
delete_form_responseDelete form responseADestructiveIdempotentInspect
Remove a form from the record it is attached to, along with any answers already given. Use this before attaching a different form, since a record holds at most one form. Requires form_responses:write scope.
Inputs: id (required).
delete_form_templateDelete form templateADestructiveIdempotentInspect
Delete a form template by ID. Requires form_templates:write scope.
Inputs: id (required).
delete_form_template_itemDelete form template itemADestructiveIdempotentInspect
Delete a form template item by ID. Requires form_template_items:write scope.
Inputs: id (required).
delete_infrastructure_assetDelete infrastructure assetADestructiveIdempotentInspect
Soft-delete an infrastructure asset (feature) by ID (sets deleted_at). Requires infrastructure_assets:write scope.
Inputs: id (required).
delete_infrastructure_asset_commentDelete infrastructure asset commentBDestructiveIdempotentInspect
Delete an infrastructure asset comment by ID. Requires infrastructure_asset_comments:write scope.
Inputs: id (required).
delete_infrastructure_asset_costDelete infrastructure asset costBDestructiveIdempotentInspect
Delete an infrastructure asset cost by ID. Requires infrastructure_asset_costs:write scope.
Inputs: id (required).
delete_infrastructure_asset_documentDelete infrastructure asset documentADestructiveIdempotentInspect
Delete an infrastructure asset document by ID. Requires infrastructure_asset_documents:write scope.
Inputs: id (required).
delete_infrastructure_asset_inspectionDelete infrastructure asset inspectionADestructiveIdempotentInspect
Soft-delete an infrastructure asset inspection by ID. Requires infrastructure_asset_inspections:write scope.
Inputs: id (required).
delete_infrastructure_asset_partDelete infrastructure asset partADestructiveIdempotentInspect
Delete an infrastructure asset part association by ID. Requires infrastructure_asset_parts:write scope.
Inputs: id (required).
delete_infrastructure_feature_classDelete infrastructure feature classADestructiveIdempotentInspect
Delete a tenant-defined infrastructure feature class by code. Builtin classes cannot be deleted. Classes referenced by any infrastructure network are protected by FK and cannot be deleted until those networks are reassigned. Requires infrastructure_feature_classes:write scope.
Inputs: code (required).
delete_infrastructure_lifecycle_eventDelete infrastructure lifecycle eventADestructiveIdempotentInspect
Delete a lifecycle strategy event by ID. Projections recompute immediately; consider update with is_active=false to disable instead. Requires infrastructure_lifecycle_events:write scope.
Inputs: id (required).
delete_infrastructure_los_targetDelete infrastructure LoS targetADestructiveIdempotentInspect
Delete an infrastructure LoS target by ID. Networks of that class stop being scored on the metric; past status snapshots are kept. Requires los_targets:write scope.
Inputs: id (required).
delete_infrastructure_networkDelete infrastructure networkADestructiveIdempotentInspect
Delete an infrastructure network by ID. Cascades to all features in the network - confirm with the user before deleting. Requires infrastructure_networks:write scope.
Inputs: id (required).
delete_infrastructure_zoneDelete infrastructure zoneADestructiveIdempotentInspect
Delete an infrastructure zone by ID. Requires infrastructure_zones:write scope.
Inputs: id (required).
delete_invoiceDelete invoiceBDestructiveIdempotentInspect
Delete an invoice by ID. Requires invoices:write scope.
Inputs: id (required).
delete_locationDelete locationBDestructiveIdempotentInspect
Delete a location by ID. Requires locations:write scope.
Inputs: id (required).
delete_location_typeDelete location typeADestructiveIdempotentInspect
Delete a location type by ID. Requires location_types:write scope.
Inputs: id (required).
delete_los_consequenceDelete LoS consequenceBDestructiveIdempotentInspect
Delete a LoS consequence by ID. Requires los_consequences:write scope.
Inputs: id (required).
delete_los_measureDelete LoS measureADestructiveIdempotentInspect
Delete a LoS measure by ID. WARNING: This also deletes all associated measurements and targets history. Requires los_measures:write scope.
Inputs: id (required).
delete_los_measurementDelete LoS measurementADestructiveIdempotentInspect
Delete a LoS measurement by ID. Requires los_measurements:write scope.
Inputs: id (required).
delete_los_proposed_targetDelete LoS proposed targetADestructiveIdempotentInspect
Delete a LoS proposed target by ID. Requires los_proposed_targets:write scope.
Inputs: id (required).
delete_manufacturerDelete manufacturerBDestructiveIdempotentInspect
Delete a manufacturer by ID. Requires manufacturers:write scope.
Inputs: id (required).
delete_partDelete partADestructiveIdempotentInspect
Delete a part/inventory item by ID. Requires parts:write scope.
Inputs: id (required).
delete_part_categoryDelete part categoryADestructiveIdempotentInspect
Delete a part category by ID. Requires part_categories:write scope.
Inputs: id (required).
delete_pm_scheduleDelete PM scheduleBDestructiveIdempotentInspect
Delete a PM schedule by ID. Requires pm_schedules:write scope.
Inputs: id (required).
delete_pm_templateDelete PM templateBDestructiveIdempotentInspect
Delete a PM template by ID. Requires pm_templates:write scope.
Inputs: id (required).
delete_projectDelete projectBDestructiveIdempotentInspect
Delete a project by ID. Requires projects:write scope.
Inputs: id (required).
delete_project_assetDelete project assetADestructiveIdempotentInspect
Remove an asset from a project by ID. Requires project_assets:write scope.
Inputs: id (required).
delete_project_budget_itemDelete project budget itemBDestructiveIdempotentInspect
Delete a project budget item by ID. Requires project_budget_items:write scope.
Inputs: id (required).
delete_project_buildingDelete project buildingADestructiveIdempotentInspect
Remove a building from a project by ID. Requires project_buildings:write scope.
Inputs: id (required).
delete_project_commentDelete project commentADestructiveIdempotentInspect
Delete a project comment by ID. Requires project_comments:write scope.
Inputs: id (required).
delete_project_cost_snapshotDelete project cost snapshotADestructiveIdempotentInspect
Delete a project cost snapshot by ID. Requires project_cost_snapshots:write scope.
Inputs: id (required).
delete_project_documentDelete project documentADestructiveIdempotentInspect
Delete a project document by ID. Requires project_documents:write scope.
Inputs: id (required).
delete_project_document_folder_templateDelete project document folder templateBDestructiveIdempotentInspect
Delete a project document folder template by ID. Requires project_document_folder_templates:write scope.
Inputs: id (required).
delete_project_infrastructure_assetDelete project infrastructure assetADestructiveIdempotentInspect
Delete a project ↔ infrastructure feature link by ID. Requires project_infrastructure_assets:write scope.
Inputs: id (required).
delete_project_locationDelete project locationADestructiveIdempotentInspect
Remove a location from a project by ID. Requires project_locations:write scope.
Inputs: id (required).
delete_project_milestoneDelete project milestoneADestructiveIdempotentInspect
Delete a project milestone by ID. Requires project_milestones:write scope.
Inputs: id (required).
delete_project_phaseDelete project phaseBDestructiveIdempotentInspect
Delete a project phase by ID. Requires project_phases:write scope.
Inputs: id (required).
delete_project_phase_categoryDelete project phase categoryBDestructiveIdempotentInspect
Delete a project phase category by ID. Requires project_phase_categories:write scope.
Inputs: id (required).
delete_project_riskDelete project riskADestructiveIdempotentInspect
Delete a project risk by ID. Requires project_risks:write scope.
Inputs: id (required).
delete_project_siteDelete project siteADestructiveIdempotentInspect
Remove a site from a project by ID. Requires project_sites:write scope.
Inputs: id (required).
delete_project_systemDelete project systemADestructiveIdempotentInspect
Remove a system from a project by ID. Requires project_systems:write scope.
Inputs: id (required).
delete_project_system_classDelete project system classADestructiveIdempotentInspect
Remove a system class from a project by ID. Requires project_system_classes:write scope.
Inputs: id (required).
delete_project_system_groupDelete project system groupBDestructiveIdempotentInspect
Remove a system group from a project by ID. Requires project_system_groups:write scope.
Inputs: id (required).
delete_project_taskDelete project taskADestructiveIdempotentInspect
Delete a project task by ID. Requires project_tasks:write scope.
Inputs: id (required).
delete_project_task_dependencyDelete project task dependencyBDestructiveIdempotentInspect
Delete a task dependency by ID. Requires project_task_dependencies:write scope.
Inputs: id (required).
delete_project_team_memberDelete project team memberADestructiveIdempotentInspect
Remove a team member from a project by ID. Requires project_team_members:write scope.
Inputs: id (required).
delete_project_time_entryDelete project time entryBDestructiveIdempotentInspect
Delete a project time entry by ID. Requires project_time_entries:write scope.
Inputs: id (required).
delete_project_updateDelete project updateBDestructiveIdempotentInspect
Delete a project update by ID. Requires project_updates:write scope.
Inputs: id (required).
delete_purchase_orderDelete purchase orderADestructiveIdempotentInspect
Delete a purchase order by ID. Requires purchase_orders:write scope.
Inputs: id (required).
delete_purchase_order_lineDelete purchase order lineADestructiveIdempotentInspect
Delete a purchase order line item. Requires purchase_orders:write scope. A line with stock received is refused until its quantity_received is set back to 0.
Inputs: id (required).
delete_purchase_order_linkDelete purchase order linkBDestructiveIdempotentInspect
Remove a purchase order link. Requires purchase_orders:write scope.
Inputs: id (required).
delete_service_areaDelete service areaADestructiveIdempotentInspect
Delete a service area by ID. WARNING: This also deletes all linked measures, measurements, and junction records. Requires service_areas:write scope.
Inputs: id (required).
delete_service_area_siteDelete service area siteADestructiveIdempotentInspect
Remove a site link from a service area. Requires service_areas:write scope.
Inputs: id (required).
delete_service_area_system_classDelete service area system classADestructiveIdempotentInspect
Remove a system class link from a service area. Requires service_areas:write scope.
Inputs: id (required).
delete_siteDelete siteADestructiveIdempotentInspect
Permanently delete a site by ID: its buildings, locations and assets are deleted with it and work orders lose their site. For a closed site, archive it instead (update_site with archived: true). Confirm with the user first. Requires sites:write scope.
Inputs: id (required).
delete_systemDelete systemBDestructiveIdempotentInspect
Delete a system by ID. Requires systems:write scope.
Inputs: id (required).
delete_system_classDelete system classBDestructiveIdempotentInspect
Delete a system class by ID. Requires systems:write scope.
Inputs: id (required).
delete_system_groupDelete system groupBDestructiveIdempotentInspect
Delete a system group by ID. Requires systems:write scope.
Inputs: id (required).
delete_system_los_targetDelete system LoS targetADestructiveIdempotentInspect
Delete a system LoS target by ID. Buildings stop being scored on that system and metric; past status snapshots are kept. Requires los_targets:write scope.
Inputs: id (required).
delete_vendorDelete vendorBDestructiveIdempotentInspect
Delete a vendor by ID. Requires vendors:write scope.
Inputs: id (required).
delete_vendor_site_assignmentDelete vendor site assignmentADestructiveIdempotentInspect
Remove a vendor-site assignment by ID. Requires vendor_site_assignments:write scope.
Inputs: id (required).
delete_work_categoryDelete work categoryADestructiveIdempotentInspect
Delete a work category by ID. Requires work_categories:write scope.
Inputs: id (required).
delete_work_orderDelete work orderADestructiveIdempotentInspect
Delete a work order by ID. Requires work_orders:write scope.
Inputs: id (required).
delete_work_order_commentDelete work order commentADestructiveIdempotentInspect
Delete a work order comment by ID. Requires work_order_comments:write scope.
Inputs: id (required).
delete_work_order_scheduleDelete work order scheduleADestructiveIdempotentInspect
Delete a work order schedule entry by ID (removes the stop from the technician's day). Requires work_order_schedules:write scope.
Inputs: id (required).
delete_work_requestDelete work requestBDestructiveIdempotentInspect
Delete a work request by ID. Requires work_requests:write scope.
Inputs: id (required).
get_assetGet assetARead-onlyIdempotentInspect
Get detailed information about a specific asset by its ID, archived or not; archived_at is set on an archived asset. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_asset_bettermentGet asset bettermentARead-onlyIdempotentInspect
Get a single betterment by ID - one capital improvement on one asset, with its cost, the service life it bought, and its in-service date. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_asset_commentGet asset commentARead-onlyIdempotentInspect
Get a single asset comment by ID.
Inputs: id (required).
get_asset_condition_assessmentGet asset condition assessmentARead-onlyIdempotentInspect
Get a single asset condition assessment by ID. Condition scores are 0-100: 85+ Excellent, 70-84 Good, 55-69 Fair, 40-54 Poor, below 40 Critical. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_asset_costGet asset costARead-onlyIdempotentInspect
Get a single asset cost record by ID - the record type shown on the main AssetLab "Expenses" page. Returns amount, cost_date, category, description, invoice_number, po_number, and related asset, site, building, and work_order. Distinct from get_expense (project-scoped expenses without invoice/PO). Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_asset_documentGet asset documentARead-onlyIdempotentInspect
Get a single asset document by ID.
Inputs: id (required).
get_asset_lifecycle_eventGet asset lifecycle eventARead-onlyIdempotentInspect
Get a single facility lifecycle strategy event by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_asset_partGet asset partBRead-onlyIdempotentInspect
Get a single asset-part association by ID, including asset and part details.
Inputs: id (required).
get_asset_placementGet asset placementCRead-onlyIdempotentInspect
Get a single asset placement by ID.
Inputs: id (required).
get_asset_replacement_planGet asset replacement planARead-onlyIdempotentInspect
Get a single asset replacement plan by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_asset_risk_history_entryGet asset risk history entryBRead-onlyIdempotentInspect
Get a single asset risk history entry by ID.
Inputs: id (required).
get_asset_statusGet asset statusBRead-onlyIdempotentInspect
Get a single asset status by ID.
Inputs: id (required).
get_attachmentGet attachmentBRead-onlyIdempotentInspect
Get a single attachment by ID.
Inputs: id (required).
get_budgetGet budgetARead-onlyIdempotentInspect
Get a single annual funding budget by ID. Use list_sites/list_buildings to resolve site_id/building_id. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_change_orderGet change orderARead-onlyIdempotentInspect
Get a change order by ID, including amount, status, vendor, and linked project. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_compliance_itemGet compliance itemBRead-onlyIdempotentInspect
Get detailed compliance item including linked PM schedules and their required frequencies.
Inputs: id (required).
get_compliance_pm_scheduleGet compliance PM scheduleBRead-onlyIdempotentInspect
Get one compliance item to PM schedule link by its ID.
Inputs: id (required).
get_compliance_recordGet compliance recordCRead-onlyIdempotentInspect
Get a single compliance record by ID.
Inputs: id (required).
get_contract_documentGet contract documentBRead-onlyIdempotentInspect
Get a single contract document by ID.
Inputs: id (required).
get_criticality_modifierGet criticality modifierARead-onlyIdempotentInspect
Get a single criticality modifier override by ID. A tier with no override uses the built-in default (critical 0.6, high 0.8, medium 1.0, low 1.4); a modifier below 1 tightens targets and one above 1 relaxes them.
Inputs: id (required).
get_custom_field_definitionGet custom field definitionARead-onlyIdempotentInspect
Get a single custom field definition by ID.
Inputs: id (required).
get_custom_field_valueGet custom field valueCRead-onlyIdempotentInspect
Get a single custom field value by ID.
Inputs: id (required).
get_dashboard_snapshotGet dashboard snapshotARead-onlyIdempotentInspect
Get a single dashboard snapshot by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_dashboard_summaryGet dashboard summaryARead-onlyIdempotentInspect
Get aggregated dashboard statistics: total assets, work orders by status, overdue count, active PM schedules, sites, and buildings.
Inputs: no named parameters.
get_expenseGet expenseARead-onlyIdempotentInspect
Get a project-scoped expense (Project → Costs → Expenses tab) by ID, including amount, date, receipt, and linked project or work order. Does NOT include invoice_number or po_number - those live on asset_costs (the main AssetLab "Expenses" page). Use get_asset_cost for that record type. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_floorplanGet floorplanARead-onlyIdempotentInspect
Get a single floorplan by ID. Returns floor metadata, PDF path, page number, and detection status.
Inputs: id (required).
get_floorplan_regionGet floorplan regionBRead-onlyIdempotentInspect
Get a single floorplan region by ID.
Inputs: id (required).
get_form_responseGet form responseBRead-onlyIdempotentInspect
Get detailed information about a specific form response by its ID.
Inputs: id (required).
get_form_response_answerGet form response answerBRead-onlyIdempotentInspect
Get detailed information about a specific form response answer by its ID.
Inputs: id (required).
get_form_templateGet form templateBRead-onlyIdempotentInspect
Get detailed information about a specific form template by its ID.
Inputs: id (required).
get_form_template_itemGet form template itemBRead-onlyIdempotentInspect
Get detailed information about a specific form template item by its ID.
Inputs: id (required).
get_infrastructure_assetGet infrastructure assetARead-onlyIdempotentInspect
Get a single infrastructure asset (feature) by ID. Returns full geometry as GeoJSON plus all attributes. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_infrastructure_asset_commentGet infrastructure asset commentBRead-onlyIdempotentInspect
Get a single infrastructure asset comment by ID.
Inputs: id (required).
get_infrastructure_asset_costGet infrastructure asset costARead-onlyIdempotentInspect
Get a single infrastructure asset cost by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_infrastructure_asset_documentGet infrastructure asset documentBRead-onlyIdempotentInspect
Get a single infrastructure asset document by ID.
Inputs: id (required).
get_infrastructure_asset_inspectionGet infrastructure asset inspectionBRead-onlyIdempotentInspect
Get a single infrastructure asset inspection by ID.
Inputs: id (required).
get_infrastructure_asset_partGet infrastructure asset partBRead-onlyIdempotentInspect
Get a single infrastructure asset part association by ID.
Inputs: id (required).
get_infrastructure_asset_risk_history_entryGet infrastructure asset risk history entryBRead-onlyIdempotentInspect
Get a single infrastructure asset risk history entry by ID. Read-only.
Inputs: id (required).
get_infrastructure_feature_classGet infrastructure feature classARead-onlyIdempotentInspect
Get a single infrastructure feature class by its code (e.g. "water_main"). Note: addressed by code, not UUID.
Inputs: code (required).
get_infrastructure_lifecycle_eventGet infrastructure lifecycle eventARead-onlyIdempotentInspect
Get a single lifecycle strategy event by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_infrastructure_los_targetGet infrastructure LoS targetARead-onlyIdempotentInspect
Get a single infrastructure LoS target by ID. base_target is the base for that feature class and metric, not what any one network is held to (list_infrastructure_los_targets explains the criticality adjustment). All three metrics are 0-100; condition is higher-is-better, fci and asset_past_useful_life_pct lower-is-better. Not money.
Inputs: id (required).
get_infrastructure_networkGet infrastructure networkBRead-onlyIdempotentInspect
Get a single infrastructure network by ID. criticality sets how strictly the network is held to its feature class's Level of Service targets; null is treated as medium.
Inputs: id (required).
get_infrastructure_zoneGet infrastructure zoneARead-onlyIdempotentInspect
Get a single infrastructure zone by ID. Boundary is returned as a GeoJSON Polygon.
Inputs: id (required).
get_invoiceGet invoiceARead-onlyIdempotentInspect
Get detailed invoice information including amounts, dates, linked vendor, project, and purchase order. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_los_consequenceGet LoS consequenceARead-onlyIdempotentInspect
Get a single LoS consequence by ID. Advisory only: no notification is sent. scope_ref holds a criticality tier, a system ID or a feature class code depending on scope_type, and is null for global.
Inputs: id (required).
get_los_measureGet LoS measureARead-onlyIdempotentInspect
Get a single LoS measure by ID, including all configuration (targets, data source, weights).
Inputs: id (required).
get_los_measurementGet LoS measurementBRead-onlyIdempotentInspect
Get a single LoS measurement by ID, including value, period, and source metadata.
Inputs: id (required).
get_los_proposed_targetGet LoS proposed targetARead-onlyIdempotentInspect
Get a single LoS proposed target by ID: measure, year, and target_value (in the measure's own unit, not money) or target_statement.
Inputs: id (required).
get_los_status_snapshotGet LoS status snapshotARead-onlyIdempotentInspect
Get a single monthly Level of Service reading by ID. actual is null when there was no data; derived_target is what that facility was held to then, after its criticality was applied. fci and asset_past_useful_life_pct are 0-100 percentages (not fractions), asset_condition_avg is 0-100 and risk_score_avg is 0-25. Not money.
Inputs: id (required).
get_los_targets_history_entryGet LoS targets history entryARead-onlyIdempotentInspect
Get a single LoS targets history entry by ID: the target, minimum and stretch goal a measure was set to on effective_date, in the measure's own unit (not money). History exists from 2026-09-20 onward only.
Inputs: id (required).
get_manufacturerGet manufacturerBRead-onlyIdempotentInspect
Get detailed manufacturer information including contact details and associated system classes.
Inputs: id (required).
get_organization_settingsGet organization settingsARead-onlyIdempotentInspect
Get this organization's display settings: currency_code (ISO 4217), timezone, date_format, company_name, org_category, and which optional modules are enabled (infrastructure, level of service; enable_floorplans is not enforced - floorplans are available on every plan). Call this before presenting any monetary amount - costs, budgets and replacement values returned by every other tool are bare numbers with no currency attached, so stating one without checking risks labelling a Canadian tenant's money as US dollars. Also the fastest way to tell an empty module from one this organization does not have.
Inputs: no named parameters.
get_partGet partARead-onlyIdempotentInspect
Get detailed information about a specific part including location and stock levels. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_part_categoryGet part categoryBRead-onlyIdempotentInspect
Get a single part category by ID.
Inputs: id (required).
get_pm_scheduleGet PM scheduleARead-onlyIdempotentInspect
Get detailed information about a specific PM schedule including tasks, resources, and linked assets. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_projectGet projectARead-onlyIdempotentInspect
Get detailed project information including budget, progress, schedule variance, and linked sites. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_project_assetGet project assetBRead-onlyIdempotentInspect
Get a single project asset assignment by ID.
Inputs: id (required).
get_project_budget_itemGet project budget itemARead-onlyIdempotentInspect
Get a single project budget item by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_project_buildingGet project buildingCRead-onlyIdempotentInspect
Get a single project building assignment by ID.
Inputs: id (required).
get_project_commentGet project commentBRead-onlyIdempotentInspect
Get a single project comment by ID.
Inputs: id (required).
get_project_cost_snapshotGet project cost snapshotARead-onlyIdempotentInspect
Get a single project cost snapshot by ID. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_project_documentGet project documentCRead-onlyIdempotentInspect
Get a single project document by ID.
Inputs: id (required).
get_project_document_folder_templateGet project document folder templateARead-onlyIdempotentInspect
Get a project document folder template by ID, including its folder structure.
Inputs: id (required).
get_project_infrastructure_assetGet project infrastructure assetARead-onlyIdempotentInspect
Get a single project ↔ infrastructure feature link by ID.
Inputs: id (required).
get_project_locationGet project locationCRead-onlyIdempotentInspect
Get a single project location assignment by ID.
Inputs: id (required).
get_project_milestoneGet project milestoneBRead-onlyIdempotentInspect
Get a single project milestone by ID.
Inputs: id (required).
get_project_phaseGet project phaseARead-onlyIdempotentInspect
Get a single project phase by ID.
Inputs: id (required).
get_project_riskGet project riskBRead-onlyIdempotentInspect
Get a single project risk by ID, including mitigation and contingency plans.
Inputs: id (required).
get_project_siteGet project siteBRead-onlyIdempotentInspect
Get a single project site assignment by ID.
Inputs: id (required).
get_project_systemGet project systemCRead-onlyIdempotentInspect
Get a single project system assignment by ID.
Inputs: id (required).
get_project_system_classGet project system classBRead-onlyIdempotentInspect
Get a single project system class assignment by ID.
Inputs: id (required).
get_project_system_groupGet project system groupBRead-onlyIdempotentInspect
Get a single project system group assignment by ID.
Inputs: id (required).
get_project_taskGet project taskARead-onlyIdempotentInspect
Get a single project task by ID, including cost and hour tracking. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_project_task_dependencyGet project task dependencyBRead-onlyIdempotentInspect
Get a single project task dependency by ID.
Inputs: id (required).
get_project_team_memberGet project team memberBRead-onlyIdempotentInspect
Get a single project team member by ID.
Inputs: id (required).
get_project_time_entryGet project time entryBRead-onlyIdempotentInspect
Get a single project time entry by ID.
Inputs: id (required).
get_project_updateGet project updateBRead-onlyIdempotentInspect
Get a single project update by ID.
Inputs: id (required).
get_purchase_orderGet purchase orderARead-onlyIdempotentInspect
Get detailed purchase order information including amount, status, vendor, and linked project. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_purchase_order_lineGet purchase order lineARead-onlyIdempotentInspect
Get one purchase order line item by ID. unit_cost is a bare number with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_purchase_order_linkGet purchase order linkBRead-onlyIdempotentInspect
Get one purchase order link by ID.
Inputs: id (required).
get_service_areaGet service areaARead-onlyIdempotentInspect
Get a single service area by ID, including linked system classes and sites.
Inputs: id (required).
get_siteGet siteARead-onlyIdempotentInspect
Get detailed information about a specific site including address and description, archived or not; archived_at is set on an archived site. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_site_fci_history_entryGet site FCI history entryBRead-onlyIdempotentInspect
Get a single site FCI history entry by ID.
Inputs: id (required).
get_system_los_targetGet system LoS targetARead-onlyIdempotentInspect
Get a single system LoS target by ID. base_target is the organization-wide base for that system and metric, not what any one building is held to (list_system_los_targets explains the criticality adjustment). fci, asset_condition_avg and asset_past_useful_life_pct are 0-100 and risk_score_avg is 0-25; condition is higher-is-better, the others lower-is-better. Not money.
Inputs: id (required).
get_userGet userARead-onlyIdempotentInspect
Get a specific organization member by their user ID. Returns name, email, and role. Requires users:read scope.
Inputs: id (required).
get_vendorGet vendorARead-onlyIdempotentInspect
Get detailed vendor information including contact details, address, and website.
Inputs: id (required).
get_vendor_site_assignmentGet vendor site assignmentARead-onlyIdempotentInspect
Get a single vendor site assignment by ID, including vendor and site names.
Inputs: id (required).
get_work_orderGet work orderARead-onlyIdempotentInspect
Get detailed information about a specific work order by its ID, including description, dates, costs, and completion details. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: id (required).
get_work_order_commentGet work order commentARead-onlyIdempotentInspect
Get a single work order comment by ID.
Inputs: id (required).
get_work_order_scheduleGet work order scheduleARead-onlyIdempotentInspect
Get a single work order schedule entry by ID.
Inputs: id (required).
get_work_requestGet work requestARead-onlyIdempotentInspect
Get detailed work request information including description, attachments, and processing status.
Inputs: id (required).
list_asset_bettermentsList asset bettermentsARead-onlyIdempotentInspect
List betterments - capital work that extended a facility asset's life, such as an elevator modernization or a boiler retube. Each records what the work cost (capitalized_amount), how much service life it bought (added_life_years), and when it went into service (occurred_on). A betterment re-bases the asset's depreciation from its own date and never changes the asset's original in-service date. Filter by asset_id, project_id or work_order_id. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, asset_id, per_page, project_id, +1 more.
list_asset_commentsList asset commentsBRead-onlyIdempotentInspect
List comments on assets. Filter by asset_id to get comments for a specific asset.
Inputs: page, asset_id, per_page.
list_asset_condition_assessmentsList asset condition assessmentsARead-onlyIdempotentInspect
List point-in-time condition assessments recorded against assets. Filter by asset, assessor, method, condition score range, or assessment date range. Condition scores are 0-100: 85+ Excellent, 70-84 Good, 55-69 Fair, 40-54 Poor, below 40 Critical. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, method, asset_id, per_page, +5 more.
list_asset_costsList asset costsARead-onlyIdempotentInspect
List asset cost records - this is what the AssetLab UI shows on the main "Expenses" page (top-level nav). Each record includes amount, cost_date, category (Acquisition, Repair, PM, Operation, Replacement, Decommission, Other), description, invoice_number, po_number, the vendor paid, and links to asset/site/building/work_order. Distinct from list_expenses, which returns project-scoped expenses without invoice/PO fields. Filter by asset, site, vendor, category, or work order. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, site_id, asset_id, category, +3 more.
list_asset_documentsList asset documentsARead-onlyIdempotentInspect
List asset documents (O&M manuals, warranties, specs, etc.). Filter by asset_id or category.
Inputs: page, search, asset_id, category, +1 more.
list_asset_lifecycle_eventsList asset lifecycle eventsARead-onlyIdempotentInspect
List facility lifecycle strategy events - condition-triggered maintenance/rehabilitation events keyed on an asset-type scope (exactly one of asset_type_id or asset_type_group_id), never on individual assets. The events sharing one scope form that scope's strategy; an asset resolves its type's own strategy first, else its type group's. Filter by asset_type_id, asset_type_group_id, event_class, or is_active. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, per_page, is_active, event_class, +2 more.
list_asset_partsList asset partsARead-onlyIdempotentInspect
List parts associated with assets. Filter by asset_id to get all parts for one asset, or by part_id to see all assets using a specific part.
Inputs: page, part_id, asset_id, per_page.
list_asset_placementsList asset placementsARead-onlyIdempotentInspect
List asset pin placements on floorplans. Each asset has at most one placement globally. Filter by floorplan_id to see all pins on one floor, or by asset_id to find where a specific asset is placed.
Inputs: page, asset_id, per_page, region_id, +1 more.
list_asset_replacement_plansList asset replacement plansARead-onlyIdempotentInspect
List asset replacement plans for lifecycle/capital planning. Filter by asset, status, priority, or planned year. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, year, status, asset_id, +2 more.
list_asset_risk_historyList asset risk historyARead-onlyIdempotentInspect
List asset risk assessment history. Shows risk scores, condition scores, and trigger events over time. Condition scores are 0-100: 85+ Excellent, 70-84 Good, 55-69 Fair, 40-54 Poor, below 40 Critical.
Inputs: page, asset_id, per_page, trigger_event.
list_assetsList assetsARead-onlyIdempotentInspect
List assets in your AssetLab account. Supports filtering by site, building, system class, system group, system, status, and text search. Archived assets (removed from service, kept for their history) are left out unless include_archived is true or status_id names a status. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, site_id, per_page, +6 more.
list_asset_statusesList asset statusesARead-onlyIdempotentInspect
List asset statuses for the organization. These define the lifecycle states an asset or infrastructure feature can be in. Each has a module: facilities (assets), infrastructure (features), or null (shared by both); pick one matching the record, or a shared one. The status with system_key archived is the built-in Archived status: assigning it to an asset archives the asset.
Inputs: page, module, search, per_page.
list_asset_type_groupsList asset type groupsBRead-onlyIdempotentInspect
List asset type group classifications. Groups organize asset types into logical categories.
Inputs: page, search, per_page.
list_asset_typesList asset typesCRead-onlyIdempotentInspect
List asset type classifications. Filter by group.
Inputs: page, search, group_id, per_page.
list_attachmentsList attachmentsARead-onlyIdempotentInspect
List file attachments linked to work orders, work requests, PM schedules, or PM templates.
Inputs: page, search, per_page, work_order_id, +3 more.
list_budgetsList budgetsARead-onlyIdempotentInspect
List annual funding budgets - one figure per year, funding source (O&M or Capital) and workspace (module), which is what the dashboard Budget tab shows. Filter by year, funding source, module, site or building. Includes allocated, budgeted, and remaining amounts. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, year, module, site_id, +3 more.
list_buildingsList buildingsARead-onlyIdempotentInspect
List buildings. Optionally filter by site to see all buildings at a specific location. Buildings of an archived site are left out unless include_archived is true.
Inputs: page, search, site_id, per_page, +1 more.
list_building_typesList building typesCRead-onlyIdempotentInspect
List building type classifications.
Inputs: page, search, per_page.
list_change_ordersList change ordersARead-onlyIdempotentInspect
List change orders. Filter by status, vendor_id, or project_id. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, status, per_page, +2 more.
list_compliance_itemsList compliance itemsARead-onlyIdempotentInspect
List compliance items (regulatory requirements tracked against PM schedules). Filter by status or system.
Inputs: page, search, status, per_page, +1 more.
list_compliance_pm_schedulesList compliance PM schedulesARead-onlyIdempotentInspect
List the PM schedules linked to a compliance item, or the compliance items a PM schedule counts toward. Pass compliance_item_id or pm_schedule_id (one is required). Each link carries required_frequency_days (how often the schedule must be completed for the item to stay compliant) and weight.
Inputs: pm_schedule_id, compliance_item_id.
list_compliance_recordsList compliance recordsBRead-onlyIdempotentInspect
List compliance records - audit trail of completed compliance checks linked to work orders and PM schedules.
Inputs: page, per_page, work_order_id, compliance_item_id.
list_contract_documentsList contract documentsBRead-onlyIdempotentInspect
List documents attached to contracts. Filter by contract_id.
Inputs: page, search, per_page, contract_id.
list_contractsList contractsARead-onlyIdempotentInspect
List vendor contracts. Filter by category or search by title. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, category, per_page.
list_contract_sitesList contract sitesARead-onlyIdempotentInspect
List contract-to-site mappings showing which contracts cover which sites. No single-record lookup (composite key).
Inputs: page, site_id, per_page, contract_id.
list_cost_categoriesList cost categoriesBRead-onlyIdempotentInspect
List cost categories used to classify expenses, invoices, and purchase orders. Supports hierarchical parent-child structure.
Inputs: page, search, per_page, is_active, +1 more.
list_criticality_modifiersList criticality modifiersARead-onlyIdempotentInspect
List the organization's criticality modifier overrides. Rows are overrides only: a tier with no row uses the built-in default (critical 0.6, high 0.8, medium 1.0, low 1.4), so an empty list means every tier is on its default. A modifier below 1 tightens the targets of facilities in that tier and one above 1 relaxes them; the allowed range is 0.1 to 1.9. Deleting a row restores the default. Filter by tier.
Inputs: page, per_page, criticality.
list_custom_field_definitionsList custom field definitionsARead-onlyIdempotentInspect
List custom field definitions configured for this tenant. Filter by entity type (e.g. asset, work_order) or field type.
Inputs: page, per_page, field_type, entity_type.
list_custom_field_valuesList custom field valuesBRead-onlyIdempotentInspect
List custom field values. Filter by entity_id to get all custom fields for a specific record, or by field_definition_id.
Inputs: page, per_page, entity_id, field_definition_id.
list_dashboard_snapshotsList dashboard snapshotsARead-onlyIdempotentInspect
List monthly dashboard snapshots with aggregate stats: asset counts, condition scores, work order metrics, and CRV totals. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, year, month, per_page.
list_expensesList expensesARead-onlyIdempotentInspect
List project-scoped expenses (the Project → Costs → Expenses tab). These records have description, amount, expense_date, receipt_url, and notes - they do NOT carry invoice_number or po_number. For the records shown on the main AssetLab "Expenses" page (which include invoice_number, po_number, category, and asset/site links), use list_asset_costs instead. Filter by project, work order, or cost category. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, per_page, project_id, +2 more.
list_floorplan_regionsList floorplan regionsARead-onlyIdempotentInspect
List labeled rooms/zones on a floorplan. Each region has a polygon (normalized 0-1 coordinates), an optional location_id linking to the Locations hierarchy, and a "reviewed" flag for AI-detected regions.
Inputs: page, per_page, reviewed, location_id, +1 more.
list_floorplansList floorplansARead-onlyIdempotentInspect
List floorplans (PDF page-level floors or site-level sheets). Filter by building_id for a building's floors, or by site_id for site-level plans (campus maps, outdoor layouts). Each floorplan belongs to exactly one of building OR site. A multi-page PDF produces multiple floorplans sharing the same pdf_storage_path.
Inputs: page, status, site_id, per_page, +1 more.
list_form_response_answersList form response answersCRead-onlyIdempotentInspect
List the per-question answer values within form responses. Read-only.
Inputs: page, item_key, per_page, response_id.
list_form_responsesList form responsesBRead-onlyIdempotentInspect
List form responses - completed or in-progress fill-outs of a form, attached to a work order or PM. Read-only.
Inputs: page, status, per_page, subject_id, +2 more.
list_form_template_itemsList form template itemsARead-onlyIdempotentInspect
List the items (questions) within form templates. Returned in sort order. Filter by template_id.
Inputs: page, per_page, template_id.
list_form_templatesList form templatesBRead-onlyIdempotentInspect
List form templates - reusable inspection, checklist, compliance, and survey definitions. Each has a module: facilities, infrastructure, or null (shared by both).
Inputs: page, module, search, status, +2 more.
list_infrastructure_asset_commentsList infrastructure asset commentsBRead-onlyIdempotentInspect
List comments on infrastructure features. Filter by feature.
Inputs: page, per_page, feature_id.
list_infrastructure_asset_costsList infrastructure asset costsARead-onlyIdempotentInspect
List cost rows for infrastructure features. Filter by feature, work order, vendor, category, or cost date range. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, category, per_page, vendor_id, +4 more.
list_infrastructure_asset_documentsList infrastructure asset documentsARead-onlyIdempotentInspect
List documents attached to infrastructure features. Filter by feature, category, or name search.
Inputs: page, search, category, per_page, +1 more.
list_infrastructure_asset_inspectionsList infrastructure asset inspectionsARead-onlyIdempotentInspect
List inspections recorded against infrastructure assets. Filter by feature, inspector, method, condition score range, or inspection date range.
Inputs: page, method, per_page, feature_id, +5 more.
list_infrastructure_asset_partsList infrastructure asset partsARead-onlyIdempotentInspect
List parts associated with infrastructure features. Filter by feature or part.
Inputs: page, part_id, per_page, feature_id.
list_infrastructure_asset_risk_historyList infrastructure asset risk historyARead-onlyIdempotentInspect
List the risk + condition history captured for infrastructure features (populated automatically when a feature's risk fields change). Read-only. Filter by feature, source, or capture date range.
Inputs: page, source, per_page, feature_id, +2 more.
list_infrastructure_assetsList infrastructure assetsARead-onlyIdempotentInspect
List infrastructure assets (features - segments or nodes). Geometry is returned as GeoJSON (Point for nodes, LineString for segments) in EPSG:4326. Filter by network, feature_type, site, status, asset type, condition score range, or risk score range. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, site_id, per_page, +9 more.
list_infrastructure_feature_classesList infrastructure feature classesARead-onlyIdempotentInspect
List infrastructure feature classes (catalog of classes like water_main, sewer_gravity, pavement). Use the code field as the natural key when referencing a class from a network. Filter by category or is_builtin.
Inputs: page, search, category, per_page, +1 more.
list_infrastructure_lifecycle_eventsList infrastructure lifecycle eventsARead-onlyIdempotentInspect
List lifecycle strategy events - condition-triggered maintenance/rehabilitation events keyed on a scope (feature_class code, material, optional diameter band), never on individual features. The events sharing one scope form that scope's strategy; features resolve the most specific matching scope like replacement rates. Filter by feature_class, material, event_class, or is_active. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, material, per_page, is_active, +2 more.
list_infrastructure_los_targetsList infrastructure LoS targetsARead-onlyIdempotentInspect
List technical Level of Service targets for infrastructure. One base target per feature class and metric, set once for the organization. Each network of that class is held to a version adjusted by the network's criticality (an unrated network counts as medium): a lower-is-better target is multiplied by the tier's modifier, a higher-is-better one keeps its distance from a perfect score multiplied by it (condition 70 becomes 82 at a Critical network, 58 at a Low one). Derived targets never leave the metric's scale. Metrics: fci (0-100 percent, lower is better), asset_condition_avg (0-100, higher is better, read with the fixed condition bands), asset_past_useful_life_pct (0-100 percent, lower is better). Average risk is not available for infrastructure. None of these values are money. Filter by feature class, metric or active.
Inputs: page, active, metric, per_page, +1 more.
list_infrastructure_networksList infrastructure networksARead-onlyIdempotentInspect
List infrastructure networks (named groupings of features bound to one feature class). criticality (critical, high, medium, low) sets how strictly a network is held to its feature class's Level of Service targets; null is treated as medium. Filter by feature_class code or text search.
Inputs: page, search, per_page, feature_class.
list_infrastructure_zonesList infrastructure zonesARead-onlyIdempotentInspect
List operational hydraulic boundaries (pressure zones, DMAs, sewersheds, etc.). Boundary is returned as a GeoJSON Polygon in EPSG:4326. Filter by network or kind.
Inputs: kind, page, per_page, network_id.
list_invoicesList invoicesARead-onlyIdempotentInspect
List invoices. Filter by status (pending, approved, paid, voided), vendor, or project. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, status, per_page, +2 more.
list_locationsList locationsARead-onlyIdempotentInspect
List locations (rooms, floors, areas within buildings). Optionally filter by building or location type. Locations of an archived site are left out unless include_archived is true.
Inputs: page, search, per_page, building_id, +2 more.
list_location_typesList location typesBRead-onlyIdempotentInspect
List location type classifications (e.g., room types, floor types).
Inputs: page, search, per_page.
list_los_consequencesList LoS consequencesARead-onlyIdempotentInspect
List Level of Service consequences: what a missed technical target means, in the organization's own words. Advisory only: the statement is shown on the Status screen when a target is breached, and no notification is sent to notify_roles or to anyone else. When several match a breach the most specific scope wins (a specific system or feature class over a criticality tier over global). severity is a floor; the severity shown scales with the size of the gap and the facility's criticality. A null metric matches any metric. Filter by scope type, severity or active.
Inputs: page, active, per_page, severity, +1 more.
list_los_measurementsList LoS measurementsARead-onlyIdempotentInspect
List LoS measurement values (time-series). Filter by measure, period type, date range, or auto/manual.
Inputs: page, date_to, is_auto, per_page, +3 more.
list_los_measuresList LoS measuresARead-onlyIdempotentInspect
List LoS measures. Filter by service area, category, type, data source, or active status.
Inputs: page, type, search, category, +4 more.
list_los_proposed_targetsList LoS proposed targetsARead-onlyIdempotentInspect
List proposed levels of service: one row per LoS measure and future year (O. Reg. 588/17 s. 6(1)). A community measure carries target_statement; a technical measure carries target_value, in the measure's own unit (not money). Filter by measure or year.
Inputs: page, year, per_page, los_measure_id.
list_los_status_snapshotsList LoS status snapshotsARead-onlyIdempotentInspect
List monthly technical Level of Service readings, newest first. Read-only. One reading per tracked pair (a system in a building, or an infrastructure network) and metric per month, recorded the first time anyone opens the Status screen in that month, so a month nobody opened it is missing rather than zero. actual is the measured value and is null when there was no data; base_target is the organization-wide target and derived_target is what that facility was held to at the time, after its criticality was applied; status is exceeding, meeting, below, failing or no_data. fci and asset_past_useful_life_pct are percentages on 0-100 (not fractions), asset_condition_avg is 0-100 and risk_score_avg is 0-25. None of these values are money. Filter by system, building, network, metric, or a period range on period_start.
Inputs: page, metric, per_page, period_to, +4 more.
list_los_targets_historyList LoS targets historyARead-onlyIdempotentInspect
List recorded changes to a LoS measure's target, minimum and stretch goal, newest first. Recording began on 2026-09-20: a change made before that date left no entry, so an empty list does not mean the target never changed. One entry per measure per day; a second change the same day overwrites that day's entry. Values are in the measure's own unit (not money). Filter by measure ID.
Inputs: page, per_page, los_measure_id.
list_manufacturersList manufacturersCRead-onlyIdempotentInspect
List manufacturers of equipment and assets.
Inputs: page, search, per_page.
list_part_categoriesList part categoriesARead-onlyIdempotentInspect
List part categories used to classify inventory parts. Each has a module: facilities, infrastructure, or null (shared by both); pick one matching the part's workspace, or a shared one.
Inputs: page, module, search, per_page.
list_partsList partsARead-onlyIdempotentInspect
List parts/inventory items. Filter by site or category. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, site_id, category, +1 more.
list_pm_schedulesList PM schedulesARead-onlyIdempotentInspect
List preventive maintenance schedules. Filter by status, frequency, or site. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, status, site_id, +2 more.
list_pm_templatesList PM templatesARead-onlyIdempotentInspect
List preventive maintenance templates that can be used to create PM schedules. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, per_page.
list_project_assetsList project assetsBRead-onlyIdempotentInspect
List asset assignments for projects. Filter by project_id or asset_id.
Inputs: page, asset_id, per_page, project_id.
list_project_budget_itemsList project budget itemsARead-onlyIdempotentInspect
List project budget line items (labor, materials, equipment, subcontractors, permits, contingency, other). Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, category, per_page, project_id.
list_project_buildingsList project buildingsARead-onlyIdempotentInspect
List building assignments for projects. Filter by project_id or building_id.
Inputs: page, per_page, project_id, building_id.
list_project_commentsList project commentsBRead-onlyIdempotentInspect
List comments on projects. Supports threaded replies via parent_id.
Inputs: page, per_page, project_id.
list_project_cost_snapshotsList project cost snapshotsARead-onlyIdempotentInspect
List historical cost snapshots for projects. Filter by project_id to see cost trends over time. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, per_page, project_id.
list_project_document_folder_templatesList project document folder templatesBRead-onlyIdempotentInspect
List project document folder templates for reusable folder structures.
Inputs: page, search, per_page.
list_project_documentsList project documentsBRead-onlyIdempotentInspect
List documents attached to projects. Filter by project_id or folder_id.
Inputs: page, search, per_page, folder_id, +1 more.
list_project_infrastructure_assetsList project infrastructure assetsBRead-onlyIdempotentInspect
List links between projects and infrastructure features. Filter by project or feature.
Inputs: page, per_page, feature_id, project_id.
list_project_locationsList project locationsARead-onlyIdempotentInspect
List location assignments for projects. Filter by project_id or location_id.
Inputs: page, per_page, project_id, location_id.
list_project_milestonesList project milestonesARead-onlyIdempotentInspect
List project milestones. Filter by project or status (pending, completed, missed, at_risk).
Inputs: page, search, status, per_page, +1 more.
list_project_phase_categoriesList project phase categoriesBRead-onlyIdempotentInspect
List project phase categories (e.g., Planning, Design, Execution). Sorted by sort_order.
Inputs: page, search, per_page.
list_project_phasesList project phasesARead-onlyIdempotentInspect
List project phases. Filter by project or status (pending, in_progress, completed, skipped).
Inputs: page, status, per_page, project_id.
list_project_risksList project risksARead-onlyIdempotentInspect
List project risks (risk register). Filter by project, status, category, probability, or impact.
Inputs: page, impact, search, status, +4 more.
list_projectsList projectsARead-onlyIdempotentInspect
List capital projects. Filter by status or health status (on_track, at_risk, delayed, critical). Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, status, per_page, +1 more.
list_project_sitesList project sitesARead-onlyIdempotentInspect
List site assignments for projects. Filter by project_id or site_id.
Inputs: page, site_id, per_page, project_id.
list_project_system_classesList project system classesARead-onlyIdempotentInspect
List system class assignments for projects. Filter by project_id or system_class_id.
Inputs: page, per_page, project_id, system_class_id.
list_project_system_groupsList project system groupsBRead-onlyIdempotentInspect
List system group assignments for projects. Filter by project_id or system_group_id.
Inputs: page, per_page, project_id, system_group_id.
list_project_systemsList project systemsBRead-onlyIdempotentInspect
List system assignments for projects. Filter by project_id or system_id.
Inputs: page, per_page, system_id, project_id.
list_project_task_dependenciesList project task dependenciesBRead-onlyIdempotentInspect
List task dependencies. Filter by task_id or depends_on_task_id to see dependency chains.
Inputs: page, task_id, per_page, dependency_type, +1 more.
list_project_tasksList project tasksBRead-onlyIdempotentInspect
List project tasks (work breakdown structure). Filter by project, phase, status, or priority. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, status, per_page, +3 more.
list_project_team_membersList project team membersBRead-onlyIdempotentInspect
List project team members. Filter by project, user, or active status.
Inputs: page, search, user_id, per_page, +2 more.
list_project_time_entriesList project time entriesBRead-onlyIdempotentInspect
List project time entries for labor tracking. Filter by project, task, or user.
Inputs: page, task_id, user_id, per_page, +1 more.
list_project_updatesList project updatesARead-onlyIdempotentInspect
List periodic project updates (status reports). Filter by project, timeframe, or year.
Inputs: page, search, per_page, timeframe, +2 more.
list_purchase_order_linesList purchase order linesARead-onlyIdempotentInspect
List purchase order line items: description, optional part, quantity, unit_cost and quantity_received. Filter by purchase_order_id or part_id. A PO with lines takes its amount from them. unit_cost is a bare number with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, part_id, per_page, purchase_order_id.
list_purchase_order_linksList purchase order linksARead-onlyIdempotentInspect
List the extra records a purchase order is linked to for reference: each row has exactly one of work_order_id, pm_schedule_id or project_id. Links never add to committed cost; the PO is charged only to its own project_id / work_order_id. Filter by any of those four IDs.
Inputs: page, per_page, project_id, work_order_id, +2 more.
list_purchase_ordersList purchase ordersARead-onlyIdempotentInspect
List purchase orders. Filter by status (draft, issued, partially_received, received, closed, cancelled), vendor, or project. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, search, status, per_page, +2 more.
list_service_areasList service areasARead-onlyIdempotentInspect
List service areas (Level of Service groupings). Filter by active status or search by name.
Inputs: page, search, per_page, is_active.
list_service_area_sitesList service area sitesARead-onlyIdempotentInspect
List site links for service areas. Filter by service_area_id or site_id.
Inputs: page, site_id, per_page, service_area_id.
list_service_area_system_classesList service area system classesBRead-onlyIdempotentInspect
List system class links for service areas. Filter by service_area_id or system_class_id.
Inputs: page, per_page, service_area_id, system_class_id.
list_site_fci_historyList site FCI historyARead-onlyIdempotentInspect
List Facility Condition Index (FCI) history for sites. fci_value is deferred renewal cost divided by current replacement value, a fraction where LOWER is healthier: below 0.05 good, 0.05-0.10 fair, 0.10 and above poor. It is not a 0-100 condition score. To chart one site, use show_site_fci_trend.
Inputs: page, site_id, per_page.
list_sitesList sitesARead-onlyIdempotentInspect
List all sites (physical locations/campuses) in your organization. Archived sites (closed, kept for their history) are left out unless include_archived is true. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: city, page, search, per_page, +1 more.
list_system_classesList system classesBRead-onlyIdempotentInspect
List system classes (top-level classification, e.g., "HVAC", "Plumbing", "Electrical").
Inputs: page, search, per_page.
list_system_groupsList system groupsARead-onlyIdempotentInspect
List system groups (categories of systems, e.g., "Heating", "Cooling"). Optionally filter by system class.
Inputs: page, search, per_page, system_class_id.
list_system_los_targetsList system LoS targetsARead-onlyIdempotentInspect
List technical Level of Service targets for building systems. One base target per system and metric, set once for the organization. Each building is held to a version adjusted by its criticality: a lower-is-better target is multiplied by the tier's modifier, a higher-is-better one keeps its distance from a perfect score multiplied by it (condition 70 becomes 82 at a Critical facility, 58 at a Low one). Derived targets never leave the metric's scale. Metrics: fci (0-100 percent, lower is better), asset_condition_avg (0-100, higher is better, read with the fixed condition bands), asset_past_useful_life_pct (0-100 percent, lower is better), risk_score_avg (0-25, lower is better). None of these values are money. Filter by system, metric or active.
Inputs: page, active, metric, per_page, +1 more.
list_systemsList systemsARead-onlyIdempotentInspect
List systems (e.g., HVAC units, plumbing systems, electrical systems). Optionally filter by system group.
Inputs: page, search, per_page, system_group_id.
list_usersList usersARead-onlyIdempotentInspect
List organization members. Returns user IDs, names, emails, and roles. Requires users:read scope. Note: This exposes personal information - only use when the user explicitly requests member data.
Inputs: page, per_page.
list_vendorsList vendorsCRead-onlyIdempotentInspect
List vendors. Filter by status, category, or city.
Inputs: city, page, search, status, +2 more.
list_vendor_site_assignmentsList vendor site assignmentsCRead-onlyIdempotentInspect
List vendor-to-site assignments showing which vendors serve which sites.
Inputs: page, site_id, per_page, vendor_id.
list_work_categoriesList work categoriesARead-onlyIdempotentInspect
List work categories used to classify work orders and requests. Each has a module: facilities, infrastructure, or null (shared by both). Pick a category whose module matches the work - infrastructure for work on a feature, facilities otherwise - or a shared one.
Inputs: page, module, search, per_page.
list_work_order_commentsList work order commentsARead-onlyIdempotentInspect
List comments on work orders. Filter by work_order_id to get comments for a specific work order.
Inputs: page, per_page, work_order_id.
list_work_ordersList work ordersARead-onlyIdempotentInspect
List work orders. Filter by status (NEW, IN_PROGRESS, ON_HOLD, COMPLETED, CANCELLED), priority (LOW, MEDIUM, HIGH, URGENT), type (PM, REACTIVE), and site. Amounts are bare numbers with no currency: call get_organization_settings for currency_code before stating one.
Inputs: page, type, search, status, +3 more.
list_work_order_schedulesList work order schedulesARead-onlyIdempotentInspect
List work order schedules (technician day plans). Filter by technician_id + scheduled_date to get one technician's ordered day: rows are returned by date, then stop_order (the day-plan stop sequence; rows without stop_order sort last), then start time. travel_time_minutes is a straight-line estimate from the previous stop.
Inputs: page, date_to, per_page, date_from, +3 more.
list_work_requestsList work requestsBRead-onlyIdempotentInspect
List work requests (submitted by requesters). Filter by status (PENDING_REVIEW, APPROVED, REJECTED) or priority.
Inputs: page, search, status, site_id, +2 more.
show_site_fci_trendShow site FCI trendARead-onlyIdempotentInspect
Show one site’s Facility Condition Index (FCI) history as a chart, in clients that render MCP Apps; other clients get the same summary as text. FCI is deferred renewal cost divided by current replacement value, a fraction where LOWER is healthier: good below 5%, fair 5-10%, poor 10% and above. It is not a 0-100 condition score. Resolve site_id with list_sites first.
Inputs: site_id (required), days.
update_assetUpdate assetADestructiveIdempotentInspect
Update an existing asset by ID. Requires assets:write scope. When changing location, resolve top-down: list_sites → list_buildings (by site_id) → list_locations (by building_id). Provide all three IDs. Same for systems: list_system_classes → list_system_groups → list_systems.
Inputs: id (required), name, model, site_id, +36 more.
update_asset_bettermentUpdate asset bettermentADestructiveIdempotentInspect
Update a betterment by ID. The asset it belongs to cannot be changed - delete and re-create to move one. Requires asset_betterments:write scope.
Inputs: id (required), description, occurred_on, added_life_years, +1 more.
update_asset_commentUpdate asset commentADestructiveIdempotentInspect
Update an existing asset comment by ID. Requires asset_comments:write scope.
Inputs: id (required), comment.
update_asset_condition_assessmentUpdate asset condition assessmentADestructiveIdempotentInspect
Update an existing asset condition assessment by ID. Requires asset_condition_assessments:write scope. Note: the purchase-cost writeback is create-only and cannot be triggered by an update.
Inputs: id (required), notes, method, defects, +4 more.
update_asset_costUpdate asset costBDestructiveIdempotentInspect
Update an existing asset cost entry by ID - the record type shown on the AssetLab "Expenses" page. Requires asset_costs:write scope.
Inputs: id (required), amount, site_id, asset_id, +9 more.
update_asset_documentUpdate asset documentBDestructiveIdempotentInspect
Update an asset document by ID. Requires asset_documents:write scope.
Inputs: id (required), name, user_id, asset_id, +5 more.
update_asset_lifecycle_eventUpdate asset lifecycle eventADestructiveIdempotentInspect
Update a facility lifecycle strategy event by ID. Editing re-confirms the cost (cost_reviewed_on is server-set). Set is_active false to disable an event without deleting it - projections recompute immediately. Requires asset_lifecycle_events:write scope.
Inputs: id (required), name, is_active, fixed_cost, +13 more.
update_asset_partUpdate asset partADestructiveIdempotentInspect
Update the quantity of an asset-part association by ID. Requires asset_parts:write scope.
Inputs: id (required), quantity.
update_asset_placementUpdate asset placementADestructiveIdempotentInspect
Move an asset placement to new coordinates or a different floorplan. Requires asset_placements:write scope.
Inputs: id (required), x, y, region_id, +1 more.
update_asset_replacement_planUpdate asset replacement planADestructiveIdempotentInspect
Update an existing asset replacement plan by ID. Requires asset_replacement_plans:write scope.
Inputs: id (required), notes, status, asset_id, +4 more.
update_asset_statusUpdate asset statusADestructiveIdempotentInspect
Update an existing asset status by ID. Requires asset_statuses:write scope. On the built-in Archived status (system_key archived) only name and description can change; it always shows red.
Inputs: id (required), name, color, module, +1 more.
update_asset_typeUpdate asset typeBDestructiveIdempotentInspect
Update an existing asset type by ID. Requires asset_types:write scope.
Inputs: id (required), name, group_id, description.
update_asset_type_groupUpdate asset type groupBDestructiveIdempotentInspect
Update an existing asset type group by ID. Requires asset_type_groups:write scope.
Inputs: id (required), name, color, description.
update_attachmentUpdate attachmentBDestructiveIdempotentInspect
Update an attachment by ID. Requires attachments:write scope.
Inputs: id (required), file_url, file_name, file_size, +7 more.
update_budgetUpdate budgetADestructiveIdempotentInspect
Update an existing budget by ID. Requires budgets:write scope.
Inputs: id (required), year, module, site_id, +4 more.
update_buildingUpdate buildingADestructiveIdempotentInspect
Update an existing building by ID. Requires buildings:write scope. latitude and longitude must be sent together; send both as null to clear the building position.
Inputs: id (required), name, type, floors, +6 more.
update_building_typeUpdate building typeBDestructiveIdempotentInspect
Update an existing building type by ID. Requires building_types:write scope.
Inputs: id (required), name, description.
update_change_orderUpdate change orderBDestructiveIdempotentInspect
Update an existing change order by ID. Requires change_orders:write scope.
Inputs: id (required), notes, amount, reason, +8 more.
update_compliance_itemUpdate compliance itemADestructiveIdempotentInspect
Update an existing compliance item by ID. Requires compliance:write scope.
Inputs: id (required), name, status, system_id, +3 more.
update_compliance_pm_scheduleUpdate compliance PM scheduleADestructiveIdempotentInspect
Change the required frequency or weight of a compliance item to PM schedule link. Requires compliance:write scope. To point a link at a different item or schedule, delete it and create a new one.
Inputs: id (required), weight, required_frequency_days.
update_compliance_recordUpdate compliance recordADestructiveIdempotentInspect
Update an existing compliance record by ID. Requires compliance_records:write scope.
Inputs: id (required), completed_at, completed_by, required_frequency_days, +1 more.
update_contractUpdate contractBDestructiveIdempotentInspect
Update an existing contract by ID. Requires contracts:write scope.
Inputs: id (required), title, category, end_date, +7 more.
update_contract_documentUpdate contract documentBDestructiveIdempotentInspect
Update a contract document by ID. Requires contract_documents:write scope.
Inputs: id (required), file_name, file_path, file_size, +3 more.
update_cost_categoryUpdate cost categoryADestructiveIdempotentInspect
Update an existing cost category by ID. Requires cost_categories:write scope.
Inputs: id (required), name, is_active, parent_id.
update_criticality_modifierUpdate criticality modifierADestructiveIdempotentInspect
Update a criticality modifier override by ID. Below 1 tightens the targets of facilities in that tier, above 1 relaxes them. Requires los_targets:write scope.
Inputs: id (required), modifier, criticality.
update_custom_field_definitionUpdate custom field definitionBDestructiveIdempotentInspect
Update an existing custom field definition by ID. Requires custom_fields:write scope.
Inputs: id (required), field_name, field_type, entity_type, +4 more.
update_custom_field_valueUpdate custom field valueADestructiveIdempotentInspect
Update an existing custom field value by ID. Set whichever typed column matches the definition's field_type (value_text / value_number / value_date / value_boolean), or pass a single value and the server will dispatch it. Requires custom_fields:write scope.
Inputs: id (required), value, entity_id, value_date, +4 more.
update_expenseUpdate expenseADestructiveIdempotentInspect
Update an existing expense by ID. Requires expenses:write scope.
Inputs: id (required), notes, amount, project_id, +5 more.
update_floorplanUpdate floorplanBDestructiveIdempotentInspect
Update floorplan metadata (rename floor, reorder, set status). Requires floorplans:write scope.
Inputs: id (required), status, floor_label, floor_order, +1 more.
update_floorplan_regionUpdate floorplan regionBDestructiveIdempotentInspect
Update a floorplan region - rename, reshape polygon, link to a Location, or mark as reviewed. Requires floorplan_regions:write scope.
Inputs: id (required), label, polygon, reviewed, +2 more.
update_form_templateUpdate form templateBDestructiveIdempotentInspect
Update an existing form template by ID. Requires form_templates:write scope.
Inputs: id (required), name, module, status, +2 more.
update_form_template_itemUpdate form template itemBDestructiveIdempotentInspect
Update an existing form template item by ID. template_id and item_key are immutable and cannot be changed. Requires form_template_items:write scope.
Inputs: id (required), label, config, options, +5 more.
update_infrastructure_assetUpdate infrastructure assetADestructiveIdempotentInspect
Update an existing infrastructure asset (feature) by ID. To change geometry, provide a new GeoJSON Point/LineString matching the existing feature_type. Computed columns (length_m, slope_pct, risk_score) cannot be set. Requires infrastructure_assets:write scope.
Inputs: id (required), name, lanes, model, +51 more.
update_infrastructure_asset_commentUpdate infrastructure asset commentBDestructiveIdempotentInspect
Update an infrastructure asset comment by ID. Requires infrastructure_asset_comments:write scope.
Inputs: id (required), comment.
update_infrastructure_asset_costUpdate infrastructure asset costBDestructiveIdempotentInspect
Update an infrastructure asset cost by ID. Requires infrastructure_asset_costs:write scope.
Inputs: id (required), amount, category, cost_date, +5 more.
update_infrastructure_asset_documentUpdate infrastructure asset documentADestructiveIdempotentInspect
Update infrastructure asset document metadata by ID. Requires infrastructure_asset_documents:write scope.
Inputs: id (required), name, category, file_path, +3 more.
update_infrastructure_asset_inspectionUpdate infrastructure asset inspectionADestructiveIdempotentInspect
Update an existing infrastructure asset inspection by ID. Requires infrastructure_asset_inspections:write scope.
Inputs: id (required), notes, method, defects, +4 more.
update_infrastructure_asset_partUpdate infrastructure asset partBDestructiveIdempotentInspect
Update an infrastructure asset part association by ID. Requires infrastructure_asset_parts:write scope.
Inputs: id (required), part_id, quantity, feature_id.
update_infrastructure_feature_classUpdate infrastructure feature classADestructiveIdempotentInspect
Update a tenant-defined infrastructure feature class (addressed by code). The code, category, and is_builtin fields are immutable; attempts to change them on a builtin class return 409. Requires infrastructure_feature_classes:write scope.
Inputs: code (required), icon, label, color_hex, +1 more.
update_infrastructure_lifecycle_eventUpdate infrastructure lifecycle eventADestructiveIdempotentInspect
Update a lifecycle strategy event by ID. Editing re-confirms the cost (cost_reviewed_on is server-set). Set is_active false to disable an event without deleting it - projections recompute immediately. Requires infrastructure_lifecycle_events:write scope.
Inputs: id (required), name, is_active, unit_cost, +15 more.
update_infrastructure_los_targetUpdate infrastructure LoS targetADestructiveIdempotentInspect
Update an infrastructure LoS target by ID. base_target stays on 0-100. Requires los_targets:write scope.
Inputs: id (required), active, metric, base_target, +1 more.
update_infrastructure_networkUpdate infrastructure networkADestructiveIdempotentInspect
Update an existing infrastructure network by ID. Requires infrastructure_networks:write scope.
Inputs: id (required), name, metadata, criticality, +3 more.
update_infrastructure_zoneUpdate infrastructure zoneADestructiveIdempotentInspect
Update an infrastructure zone by ID. Pass boundary as a GeoJSON Polygon or MultiPolygon to replace the geometry. Requires infrastructure_zones:write scope.
Inputs: id (required), code, kind, name, +3 more.
update_invoiceUpdate invoiceADestructiveIdempotentInspect
Update an existing invoice by ID. Requires invoices:write scope.
Inputs: id (required), notes, amount, status, +11 more.
update_locationUpdate locationBDestructiveIdempotentInspect
Update an existing location by ID. Requires locations:write scope.
Inputs: id (required), area, name, type, +3 more.
update_location_typeUpdate location typeADestructiveIdempotentInspect
Update an existing location type by ID. Requires location_types:write scope.
Inputs: id (required), name, description.
update_los_consequenceUpdate LoS consequenceADestructiveIdempotentInspect
Update a LoS consequence by ID. Changing scope_type to global clears scope_ref; changing it to anything else needs a scope_ref that fits the new type. Advisory only: no notification is sent. Requires los_consequences:write scope.
Inputs: id (required), active, metric, severity, +4 more.
update_los_measureUpdate LoS measureBDestructiveIdempotentInspect
Update an existing LoS measure by ID. Requires los_measures:write scope.
Inputs: id (required), name, type, unit, +12 more.
update_los_measurementUpdate LoS measurementADestructiveIdempotentInspect
Update an existing LoS measurement by ID. Requires los_measurements:write scope.
Inputs: id (required), notes, is_auto, period_end, +3 more.
update_los_proposed_targetUpdate LoS proposed targetBDestructiveIdempotentInspect
Update an existing LoS proposed target by ID. Requires los_proposed_targets:write scope.
Inputs: id (required), year, target_value, target_statement.
update_manufacturerUpdate manufacturerADestructiveIdempotentInspect
Update an existing manufacturer by ID. Requires manufacturers:write scope.
Inputs: id (required), name, notes, website, +3 more.
update_partUpdate partADestructiveIdempotentInspect
Update an existing part/inventory item by ID. Requires parts:write scope.
Inputs: id (required), cost, name, site_id, +9 more.
update_part_categoryUpdate part categoryBDestructiveIdempotentInspect
Update an existing part category by ID. Requires part_categories:write scope.
Inputs: id (required), name, module, description.
update_pm_scheduleUpdate PM scheduleADestructiveIdempotentInspect
Update an existing PM schedule by ID. Requires pm_schedules:write scope. When changing location, resolve top-down: list_sites → list_buildings (by site_id) → list_locations (by building_id). Provide all three IDs.
Inputs: id (required), tasks, title, status, +28 more.
update_pm_templateUpdate PM templateADestructiveIdempotentInspect
Update an existing PM template by ID. Requires pm_templates:write scope.
Inputs: id (required), tasks, title, priority, +13 more.
update_projectUpdate projectBDestructiveIdempotentInspect
Update an existing project by ID. Requires projects:write scope.
Inputs: id (required), name, status, end_date, +11 more.
update_project_budget_itemUpdate project budget itemBDestructiveIdempotentInspect
Update an existing project budget item by ID. Requires project_budget_items:write scope.
Inputs: id (required), notes, category, project_id, +3 more.
update_project_commentUpdate project commentBDestructiveIdempotentInspect
Update an existing project comment by ID. Requires project_comments:write scope.
Inputs: id (required), content, parent_id.
update_project_documentUpdate project documentBDestructiveIdempotentInspect
Update a project document by ID. Requires project_documents:write scope.
Inputs: id (required), name, file_path, file_size, +5 more.
update_project_document_folder_templateUpdate project document folder templateBDestructiveIdempotentInspect
Update a project document folder template by ID. Requires project_document_folder_templates:write scope.
Inputs: id (required), name, structure, is_default, +1 more.
update_project_infrastructure_assetUpdate project infrastructure assetBDestructiveIdempotentInspect
Update a project ↔ infrastructure feature link by ID. Requires project_infrastructure_assets:write scope.
Inputs: id (required), notes, feature_id, project_id.
update_project_milestoneUpdate project milestoneBDestructiveIdempotentInspect
Update an existing project milestone by ID. Requires project_milestones:write scope.
Inputs: id (required), name, status, due_date, +5 more.
update_project_phaseUpdate project phaseADestructiveIdempotentInspect
Update an existing project phase by ID. Requires project_phases:write scope.
Inputs: id (required), name, status, end_date, +4 more.
update_project_phase_categoryUpdate project phase categoryADestructiveIdempotentInspect
Update an existing project phase category by ID. Requires project_phase_categories:write scope.
Inputs: id (required), name, sort_order, description.
update_project_riskUpdate project riskADestructiveIdempotentInspect
Update an existing project risk by ID. Requires project_risks:write scope.
Inputs: id (required), title, impact, status, +8 more.
update_project_taskUpdate project taskADestructiveIdempotentInspect
Update an existing project task by ID. Requires project_tasks:write scope.
Inputs: id (required), title, status, due_date, +10 more.
update_project_team_memberUpdate project team memberBDestructiveIdempotentInspect
Update a project team member by ID. Requires project_team_members:write scope.
Inputs: id (required), role, user_id, end_date, +4 more.
update_project_time_entryUpdate project time entryADestructiveIdempotentInspect
Update an existing project time entry by ID. Requires project_time_entries:write scope.
Inputs: id (required), task_id, user_id, end_time, +6 more.
update_project_updateUpdate project updateBDestructiveIdempotentInspect
Update an existing project update by ID. Requires project_updates:write scope.
Inputs: id (required), title, content, author_id, +4 more.
update_purchase_orderUpdate purchase orderADestructiveIdempotentInspect
Update an existing purchase order by ID. Requires purchase_orders:write scope.
Inputs: id (required), notes, amount, status, +8 more.
update_purchase_order_lineUpdate purchase order lineADestructiveIdempotentInspect
Update a purchase order line item. Requires purchase_orders:write scope. To receive goods, set quantity_received; for a line with a part, the change is added to (or taken from) that part's stock. A line with stock received cannot change its part.
Inputs: id (required), part_id, quantity, unit_cost, +3 more.
update_service_areaUpdate service areaBDestructiveIdempotentInspect
Update an existing service area by ID. Requires service_areas:write scope.
Inputs: id (required), icon, name, color, +3 more.
update_siteUpdate siteADestructiveIdempotentInspect
Update an existing site by ID, or archive / restore it with archived. Archiving a site archives its buildings, locations and assets in one step and keeps every linked work order; prefer it to delete_site for a closed site. Requires sites:write scope.
Inputs: id (required), city, name, address, +26 more.
update_systemUpdate systemADestructiveIdempotentInspect
Update an existing system by ID. Requires systems:write scope.
Inputs: id (required), name, description, crv_multiplier, +1 more.
update_system_classUpdate system classBDestructiveIdempotentInspect
Update an existing system class by ID. Requires systems:write scope.
Inputs: id (required), name, description.
update_system_groupUpdate system groupADestructiveIdempotentInspect
Update an existing system group by ID. Requires systems:write scope.
Inputs: id (required), name, description, system_class_id.
update_system_los_targetUpdate system LoS targetADestructiveIdempotentInspect
Update a system LoS target by ID. base_target must sit on the scale of the metric in force (0-100, or 0-25 for risk_score_avg), so send a new base_target when changing to a metric with a smaller scale. Direction follows the metric automatically. Requires los_targets:write scope.
Inputs: id (required), active, metric, system_id, +1 more.
update_vendorUpdate vendorADestructiveIdempotentInspect
Update an existing vendor by ID. Requires vendors:write scope.
Inputs: id (required), city, name, state, +9 more.
update_work_categoryUpdate work categoryADestructiveIdempotentInspect
Update an existing work category by ID. Requires work_categories:write scope.
Inputs: id (required), name, module, description.
update_work_orderUpdate work orderADestructiveIdempotentInspect
Update an existing work order by ID. Requires work_orders:write scope. When changing location, resolve top-down: list_sites → list_buildings (by site_id) → list_locations (by building_id). Provide all three IDs. To complete a work order, set status COMPLETED and say what was done in completion_notes; completed_at is stamped automatically.
Inputs: id (required), type, title, status, +22 more.
update_work_order_commentUpdate work order commentBDestructiveIdempotentInspect
Update an existing work order comment by ID. Requires work_order_comments:write scope.
Inputs: id (required), comment.
update_work_order_scheduleUpdate work order scheduleADestructiveIdempotentInspect
Update a work order schedule entry by ID (date, times, stop_order, notes). work_order_id is immutable. Requires work_order_schedules:write scope.
Inputs: id (required), stop_order, technician_id, scheduled_date, +5 more.
update_work_requestUpdate work requestADestructiveIdempotentInspect
Update an existing work request by ID. Requires work_requests:write scope. Setting status to APPROVED creates a new work order from the request (its title, location and asset carry over) - confirm with the user first, and look the work order up afterwards with list_work_orders; REJECTED creates nothing. When changing location, resolve top-down: list_sites → list_buildings (by site_id) → list_locations (by building_id). Provide all three IDs.
Inputs: id (required), title, status, site_id, +7 more.
upload_fileUpload fileAInspect
Upload a file to AssetLab storage by sending its bytes inline (base64). The AssetLab backend performs the storage upload server-side - use this tool when the client cannot PUT directly to Supabase Storage (e.g. Claude integrations whose outbound network blocks arbitrary supabase.co hosts). Returns { path, bucket, file_size, content_type }. After uploading, pass path to the appropriate record tool (update_asset image_url, create_asset_document file_path, update_work_order image_url, create_attachment file_url, create_project_document file_path, create_contract_document file_path). Server limit is ~10 MB decoded; MCP arg ceiling effectively caps file size around 700 KB-1 MB. For larger files, use create_upload_url instead. Requires upload_urls:write scope.
Inputs: bucket (required), file_name (required), content_base64 (required), content_type.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
Related MCP Connectors
Read assets, work orders and service requests; add and change assets and work orders in TreePlotter.
Track tools, equipment and assets: inventory and asset management, assign, report, set up by chat.
Read-only UteamUP CMMS connector for finding assets and work orders and viewing asset details through five tools. Sign in with OAuth; access follows your company permissions.
Work orders for site jobs: parts and labour, status steps, completion reports, invoice lines.
Related MCP Servers
- AlicenseBqualityBmaintenanceConnects Claude, ChatGPT, Microsoft Copilot, and other MCP clients to an AssetLab asset management account, letting users query and manage work orders, PM schedules, capital projects, infrastructure networks, and other records in plain language. It exposes 480+ scoped, tenant-bound, audited tools with both read and write access, hosted or run locally over stdio.481230 npmMIT
- AlicenseAqualityBmaintenanceLets users track equipment maintenance with service entries, costs, and automatically computed due and overdue schedules.836 npmMIT
- AlicenseNot gradedqualityBmaintenanceEnables Claude to query and manage Atlas CMMS work orders, procedure tasks, evidence notes, and assets through the Atlas REST API over Streamable HTTP, with automatic service-account JWT authentication and human-readable output. Supports filtering, status changes, assignments, and weekly executive reporting.17 npmApache 2.0
- AlicenseBqualityBmaintenance67 tools generated from the same OpenAPI spec as our SDKs — CI fails on drift, so REST and MCP never disagree. Underneath: a deterministic field operations scheduling engine — skills, territories, live availability, sub-3-second cascade rescheduling — drivable end-to-end from Claude or ChatGPT. Schedule changes preview before they commit; LLMs never inside the math.5370 npm3MIT
Glama MCP Gateway
Add one secure layer between your agents and this server.