# Mangrove Documentation

- [Mangrove Overview](https://docs.mangrovesystems.com/overview.md): Your guide to using Mangrove.
- [Getting Started](https://docs.mangrovesystems.com/production-accounting/getting-started.md): Take the following steps to set up your project for MRV and production accounting in Mangrove.
- [Production Accounting Fundamentals](https://docs.mangrovesystems.com/production-accounting/fundamentals.md): Key production accounting concepts used in Mangrove
- [Create a new project](https://docs.mangrovesystems.com/production-accounting/add-project.md): Projects in Mangrove are managed in the "Projects" section.
- [Configure data inputs](https://docs.mangrovesystems.com/production-accounting/data-inputs.md): Data inputs feed into the production models of Mangrove, driving the calculations that are fundamental to the calculation of each project’s production.
- [Connect data sources](https://docs.mangrovesystems.com/data-collection/data-sources.md): Data can be ingested from connected data sources on a project.
- [Build accounting models](https://docs.mangrovesystems.com/production-accounting/models.md): A model represents a discrete set of calculations and data associations to generate production accounting. There are 2 main types of models in Mangrove: production models, and quantification models.
- [Mass Balance Accounting](https://docs.mangrovesystems.com/production-accounting/mass-balance-accounting.md): Track material flows and their associated MRV calculations across various stages of your project.
- [Configure project locations](https://docs.mangrovesystems.com/production-accounting/locations.md): Track locations within your project boundary where activity is occurring.
- [Manage project assets](https://docs.mangrovesystems.com/production-accounting/assets.md): Track the physical equipment behind your production data — chargers, meters, wells, kilns, vehicles — as first-class assets.
- [Generate batches](https://docs.mangrovesystems.com/production-accounting/generate-batches.md): Calculate the ongoing production outputs using collected data.
- [Feedstock Accounting](https://docs.mangrovesystems.com/production-accounting/feedstocks.md): Track different input materials used in your production processes and perform production accounting on a per-feedstock basis. This allows you to split production into unique feedstock-specific batches, providing granular visibility into how different input materials contribute to your outputs and ca…
- [Generate CI scores](https://docs.mangrovesystems.com/production-accounting/generate-scores.md): Calculate CI scores from actual and forecast production data from a reporting period.
- [Embodied Emissions](https://docs.mangrovesystems.com/production-accounting/embodied-emissions.md): Track and amortize the carbon cost of facilities and equipment across production batches.
- [Instruments](https://docs.mangrovesystems.com/production-accounting/instruments.md): Track renewable energy certificates (RECs) and renewable fuel certificates as inventory, and allocate them to production batches.
- [Uncertainty propagation](https://docs.mangrovesystems.com/production-accounting/uncertainty-propagation.md)
- [Model Operators](https://docs.mangrovesystems.com/production-accounting/model-expressions.md): Write mathematical and logical operators in Mangrove's models.
- [Data Collection Pathways](https://docs.mangrovesystems.com/data-collection/pathways.md)
- [Review data points](https://docs.mangrovesystems.com/data-collection/data-points.md): Work through collected data one value at a time in the Events table: filter, sort, check health, export, and delete.
- [Add events directly](https://docs.mangrovesystems.com/data-collection/add-data.md): Directly add individual events in the Data Inputs section of the project.
- [Track transport events](https://docs.mangrovesystems.com/data-collection/add-transport-events.md): Record transport trips within your project for transport emissions calculations.
- [Bulk import data](https://docs.mangrovesystems.com/data-collection/bulk-import.md): In the Data Inputs section, bulk import data through a project-specific Data Source.
- [Activate a SQL data connector](https://docs.mangrovesystems.com/data-collection/activate-data-connector.md): Connect external SQL databases to automatically sync data into your Mangrove project.
- [Request data from external partners](https://docs.mangrovesystems.com/data-collection/request-data.md): Send a request to a data partner asking them to upload files and data for a project, then review what comes back.
- [Schedule recurring data requests](https://docs.mangrovesystems.com/data-collection/schedule-data-requests.md): Set up a data request to send automatically on a recurring cadence — weekly or monthly — instead of creating a new request each cycle.
- [Submit to Data Requests](https://docs.mangrovesystems.com/data-collection/submit-to-data-request.md): Submit data that is requested for a project in Mangrove.
- [Evidence Checks](https://docs.mangrovesystems.com/data-collection/evidence-checks.md): Use evidence checks to validate that event datapoints match their attached evidence before reporting.
- [Data Rules Fundamentals](https://docs.mangrovesystems.com/data-rules/fundamentals.md): Catch data quality issues automatically with project-defined rules that flag events and batch calculations.
- [Create a Data Rule](https://docs.mangrovesystems.com/data-rules/create-a-rule.md): Walk through writing, validating, and saving a project data rule.
- [Rule Expressions](https://docs.mangrovesystems.com/data-rules/rule-expressions.md): Reference for the rule expression language: variables, operators, comparisons, and aggregates.
- [Manage Rule Alerts](https://docs.mangrovesystems.com/data-rules/manage-alerts.md): Review, dismiss, and act on alerts raised by data rules across events, batches, and reports.
- [Reporting Fundamentals](https://docs.mangrovesystems.com/reporting/fundamentals.md): Key reporting concepts used in Mangrove
- [Report project data to a registry](https://docs.mangrovesystems.com/reporting/report-production.md): Batches on the Production Accounting must be allocated to specific credit issuances to attach the collected production data to that issuance and estimate the resulting credit quantity.
- [Sync reporting directly to registries](https://docs.mangrovesystems.com/reporting/integrations.md): Production data can be directly reported through a connection to select registries and value streams that support integrations.
- [Share a report with an auditor](https://docs.mangrovesystems.com/reporting/audit-hub.md): Give a third-party auditor read-only access to a report, its batches, and its evidence, without sending files by email.
- [Getting started](https://docs.mangrovesystems.com/inventory/getting-started.md): Take the following steps to set up your inventory of credits and environmental attributes.
- [Inventory Fundamentals](https://docs.mangrovesystems.com/inventory/fundamentals.md): Key credit inventory concepts used in Mangrove
- [Track customer orders](https://docs.mangrovesystems.com/inventory/orders.md): An order represents a request made by a customer for credit inventory. Each order contains details such as the customer's information, the order terms and status, and the deliveries included in the order.
- [Unit prices and fees](https://docs.mangrovesystems.com/inventory/prices-fees.md): The unit price of customer deliveries can be recorded in Mangrove, along with any expected fees due to value streams.
- [Transfer credits](https://docs.mangrovesystems.com/inventory/transfers.md): Credit transfers to your Customers can be recorded within Mangrove to keep your inventory up to date.
- [Retire credits](https://docs.mangrovesystems.com/inventory/retirements.md): Credit retirements can be recorded within Mangrove to keep your inventory up to date.
- [Customer Portal](https://docs.mangrovesystems.com/inventory/customer-portal.md): Invite customers into a branded portal to share MRV data for their deliveries.
- [Custom Fields](https://docs.mangrovesystems.com/account-admin/custom-fields.md): Custom Fields extend the Mangrove data model to capture information that doesn't fit into standard fields — on projects and on assets. This enables each record to maintain a single source of truth for all relevant data, directly within Mangrove.
- [Notifications](https://docs.mangrovesystems.com/account-admin/notifications.md): In the dynamic environment of Mangrove, staying informed about ongoing activities and updates is crucial for effective management of production data and credit inventory. Stay updated on platform activities relevant to your projects and commercial operations through configured notifications.
- [User roles](https://docs.mangrovesystems.com/account-admin/user-roles.md): Below are the various user roles that can be assigned in Mangrove by Account Admins
- [Brand settings](https://docs.mangrovesystems.com/account-admin/brand-settings.md): The Brand Settings you configure in the Admin section allow you to apply your brand to external-facing parts of the software.
- [Portfolio Account Management](https://docs.mangrovesystems.com/portfolio/portfolio-account-management.md): Provide partners with dedicated accounts and branded portals for streamlined MRV data management
- [Supplier Payments](https://docs.mangrovesystems.com/portfolio/supplier-payments.md): Manage supplier payments
- [Authentication](https://docs.mangrovesystems.com/api-reference/authentication.md): Authenticating with the Mangrove API.
- [Status Codes](https://docs.mangrovesystems.com/api-reference/status-codes.md): Status codes returned by the Mangrove API.
- [Pagination](https://docs.mangrovesystems.com/api-reference/pagination.md): How collections are paginated in the API.
- [Rate Limits](https://docs.mangrovesystems.com/api-reference/rate-limits.md): Limits on requests to the Mangrove API.
- [API Support](https://docs.mangrovesystems.com/api-reference/support.md): Get Support with the Mangrove API
- [MCP Integration](https://docs.mangrovesystems.com/api-reference/mcp-setup.md): Connect your Mangrove data to AI assistants using the Model Context Protocol
- [Sending time series data to Mangrove](https://docs.mangrovesystems.com/api-reference/cookbooks/sync-events.md): Send well-formed event data, associated with the right locations and evidence, for easy review and MRV accounting.
- [Attaching evidence to multiple events](https://docs.mangrovesystems.com/api-reference/cookbooks/bulk-evidence-upload.md): Upload evidence files to multiple Mangrove events using the API.
- [Dismissing many rule alerts at once](https://docs.mangrovesystems.com/api-reference/cookbooks/bulk-dismiss-alerts.md): Find and dismiss data rule alerts in bulk using the Mangrove API.
- [Correcting many values at once](https://docs.mangrovesystems.com/api-reference/cookbooks/substitute-values.md): Write a substitute rule through the Mangrove API to correct bad or missing readings automatically, and read back what it changed.
- [Generating batches via the API](https://docs.mangrovesystems.com/api-reference/cookbooks/batch-generation.md): Use the Mangrove API to check required inputs, preview batch generation, and trigger batch creation for a ledger.
- [Data Exports](https://docs.mangrovesystems.com/api-reference/exports/overview.md): Export large datasets as CSV or JSON files via the API.
- [Retrieve all projects](https://docs.mangrovesystems.com/api-reference/projects/get.md): Returns an array of all projects with filtering and sorting capabilities.
- [Retrieve a project](https://docs.mangrovesystems.com/api-reference/projects/get-project.md): Returns a specific project by ID.
- [Update a project](https://docs.mangrovesystems.com/api-reference/projects/patch.md): Updates a project. Only project owner or account admin can update projects.
- [The Project object](https://docs.mangrovesystems.com/api-reference/projects/project.md): A Project is defined as a set of activities that, as a whole, produces net climate benefits relative to a baseline scenario.
- [All locations on a project](https://docs.mangrovesystems.com/api-reference/locations/get-all.md): List all locations of a given project.
- [Retrieve a location](https://docs.mangrovesystems.com/api-reference/locations/get.md): Retrieves a specific location by id.
- [Create a location](https://docs.mangrovesystems.com/api-reference/locations/create.md): Create a new location for the given project.
- [Update a location](https://docs.mangrovesystems.com/api-reference/locations/patch.md): Update a specific location by id.
- [Delete a location](https://docs.mangrovesystems.com/api-reference/locations/delete.md): Destroy a location by id.
- [The Location object](https://docs.mangrovesystems.com/api-reference/locations/location.md): Locations are physical places within a project's boundaries where project activity occurs.
- [List assets](https://docs.mangrovesystems.com/api-reference/assets/get-all.md): Returns all assets for the account. Assets are account-scoped — use `filter[project_id][eq]` to narrow to a single project.
- [Retrieve an asset](https://docs.mangrovesystems.com/api-reference/assets/get.md): Returns a specific asset by friendly ID.
- [Create an asset](https://docs.mangrovesystems.com/api-reference/assets/create.md): Creates a new asset. At least one of `location_id` or `project_id` is required — an asset can belong to a location, to a project directly, or both. Neither is inferred from the other.
- [Update an asset](https://docs.mangrovesystems.com/api-reference/assets/patch.md): Updates an asset. `custom_field_values` replaces the entire map — merge your changes into the current values first, or unlisted keys are silently cleared. Pass an empty string for `location_id` or `project_id` to detach.
- [Delete an asset](https://docs.mangrovesystems.com/api-reference/assets/delete.md): Deletes an asset. This action cannot be undone.
- [List all feedstocks](https://docs.mangrovesystems.com/api-reference/feedstocks/get-all.md): Returns an array of all feedstocks across all projects for the authenticated account, with filtering and sorting capabilities.
- [Create an event type](https://docs.mangrovesystems.com/api-reference/event-types/create.md): Creates a new event type for a project.
- [List event types on a project](https://docs.mangrovesystems.com/api-reference/event-types/get-event-types.md): Shows all configured event types that a project can accept with filtering and sorting capabilities.
- [Retrieve an event type](https://docs.mangrovesystems.com/api-reference/event-types/get.md): Returns a specific event type by ID.
- [Update an event type](https://docs.mangrovesystems.com/api-reference/event-types/patch.md): Updates an existing event type.
- [Delete an event type](https://docs.mangrovesystems.com/api-reference/event-types/delete.md): Deletes an event type.
- [List all events on a project](https://docs.mangrovesystems.com/api-reference/events/get-all.md): Lists all events on a specific project with filtering and sorting capabilities.
- [Retrieve an event](https://docs.mangrovesystems.com/api-reference/events/get.md): Retrieves a specific event by ID.
- [Create an event](https://docs.mangrovesystems.com/api-reference/events/create.md): Creates events to capture ongoing operational data within a specific project boundary.
- [Update an event](https://docs.mangrovesystems.com/api-reference/events/patch.md): Updates a specific event by ID.
- [Delete an event](https://docs.mangrovesystems.com/api-reference/events/delete.md): Delete the event and its data points. Evidence files will not be deleted.
- [The Event object](https://docs.mangrovesystems.com/api-reference/events/event.md): An Event is an operational activity taking place within a project's boundaries.
- [List all data point types on a project](https://docs.mangrovesystems.com/api-reference/data-point-types/get-all.md): Shows all configured data point types that a project can accept.
- [Retrieve a data point type](https://docs.mangrovesystems.com/api-reference/data-point-types/get.md): Returns a specific data point type by ID.
- [Create a data point type](https://docs.mangrovesystems.com/api-reference/data-point-types/create.md): Creates a new data point type for a project.
- [Delete a data point type](https://docs.mangrovesystems.com/api-reference/data-point-types/delete.md): Deletes a data point type from a project.
- [List all static inputs](https://docs.mangrovesystems.com/api-reference/static-inputs/get-all.md): Returns all static inputs for a project.
- [Retrieve a static input](https://docs.mangrovesystems.com/api-reference/static-inputs/get.md): Returns a specific static input by ID.
- [Create a static input](https://docs.mangrovesystems.com/api-reference/static-inputs/create.md): Creates a new static input for a project.
- [Update a static input](https://docs.mangrovesystems.com/api-reference/static-inputs/patch.md): Updates a static input. Changing value_type requires providing a new value.
- [Delete a static input](https://docs.mangrovesystems.com/api-reference/static-inputs/delete.md): Deletes a static input. Cannot delete if it has events in a batch.
- [List all datapoints on an event](https://docs.mangrovesystems.com/api-reference/datapoints/get-all.md): Lists all datapoints on a specific event with filtering and sorting capabilities.
- [Get data points for a project](https://docs.mangrovesystems.com/api-reference/datapoints/get-project-datapoints.md): List data points across all events in a project. All query params are optional filters.
- [Retrieve a datapoint](https://docs.mangrovesystems.com/api-reference/datapoints/get.md): Retrieves a specific datapoint by ID.
- [Create a datapoint on an event](https://docs.mangrovesystems.com/api-reference/datapoints/create.md): Adds a datapoint to an event. An event can be associated with multiple datapoints.
- [Update a datapoint](https://docs.mangrovesystems.com/api-reference/datapoints/patch.md): Update an existing datapoint. An event can be associated with multiple datapoints.
- [Delete a datapoint](https://docs.mangrovesystems.com/api-reference/datapoints/delete.md): Deletes a specific datapoint by ID.
- [The Datapoint object](https://docs.mangrovesystems.com/api-reference/datapoints/datapoint.md): A datapoint represents a defined value to be used in a production accounting or quantification.
- [Correct a data point value](https://docs.mangrovesystems.com/api-reference/corrections/set-value.md): Substitutes the value of one data point, addressed by its data point type slug within an event. Use it to replace a wrong reading, or to set a value where none was recorded. The server records the previous value as `from_value`, which is null when no reading existed, and creates the data point on th…
- [Revert a data point correction](https://docs.mangrovesystems.com/api-reference/corrections/revert.md): Reverts the most recent correction on a data point, restoring the value it held before that correction. The revert is appended to the history as a `revert` correction; nothing is deleted.
- [List a data point's corrections](https://docs.mangrovesystems.com/api-reference/corrections/get-all.md): Lists the corrections recorded on one data point, oldest first, giving the audit trail behind its current value. Reverts appear as their own entries with `method: revert`. Corrections written by a data rule carry the rule that produced them.
- [Correct many data point values](https://docs.mangrovesystems.com/api-reference/corrections/batch.md): Applies many corrections in one all-or-nothing request. Each item speaks the same shape as a single correction and addresses its data point by event ID and slug, so one call can span many events and event types.
- [List all evidences on an event](https://docs.mangrovesystems.com/api-reference/evidence/get-all.md): Lists all evidences on a specific project's event.
- [Retrieve an evidence](https://docs.mangrovesystems.com/api-reference/evidence/get.md): Retrieves a specific piece of evidence by ID.
- [Create evidence on event](https://docs.mangrovesystems.com/api-reference/evidence/create.md): Adds evidence to an event. An event can be associated with multiple pieces of evidence.
- [Delete an evidence](https://docs.mangrovesystems.com/api-reference/evidence/delete.md): Deletes a specific piece of evidence by ID.
- [The Evidence object](https://docs.mangrovesystems.com/api-reference/evidence/evidence.md): An Evidence is a file or URL that provides supporting evidence for a specific event measured.
- [Send Bulk CSV to a Project Data Feed](https://docs.mangrovesystems.com/api-reference/data-feeds/send-bulk-csv.md): Uploads a CSV file to an ingestion Data Feed for processing. The Data Feed must have a "Endpoint" source configured. The file will be processed asynchronously through the pipeline's stages (collection, transformation, publication).
- [List rules](https://docs.mangrovesystems.com/api-reference/data-rules/get-all.md): Lists the data rules on a project, most recently created first. Requires a token with Data Rules read permission.
- [Retrieve a rule](https://docs.mangrovesystems.com/api-reference/data-rules/get.md)
- [Create a rule](https://docs.mangrovesystems.com/api-reference/data-rules/create.md): Creates a data rule on the project. A rule either flags matching records with an alert, or corrects the matching value by working through a chain of substitution methods.
- [Update a rule](https://docs.mangrovesystems.com/api-reference/data-rules/patch.md): Updates a rule. Changing the condition, the effective period, the action or the method chain mints a new version and queues a re-evaluation, and the response carries `backfill_enqueued` to say so. Changing only the name or the alert message updates the rule in place.
- [Delete a rule](https://docs.mangrovesystems.com/api-reference/data-rules/delete.md): Deletes the rule along with its results and alerts. A rule that has written a correction cannot be deleted at all: reverting a correction appends an entry rather than removing it, so the count never falls to zero. Set an effective_to date to stop the rule instead.
- [Preview a rule](https://docs.mangrovesystems.com/api-reference/data-rules/preview.md): Evaluates a condition against recent records and reports what would pass and what would fail, without saving anything. Use it to size an alert before committing to it.
- [List a rule's results](https://docs.mangrovesystems.com/api-reference/data-rules/results.md): Lists the per-record outcome of a rule, one entry per record it evaluated. Defaults to the rule's latest version.
- [Get a rule's stats](https://docs.mangrovesystems.com/api-reference/data-rules/stats.md): Aggregate counts for a rule version, so you can size its effect without paging through every result.
- [Bulk dismiss rule results](https://docs.mangrovesystems.com/api-reference/data-rules/bulk-dismiss.md): Dismisses many data rule results (alerts) in a single request, across any rules in the project. Each result is identified by its rule-result friendly ID (`dpres_...` for data point results, `mrres_...` for model run results); data point and model run results can be mixed in one call. The same dismis…
- [Rule expression grammar](https://docs.mangrovesystems.com/api-reference/data-rules/syntax.md): Returns the canonical grammar for the rule expression language: the variable forms, operators, aggregate functions, and window units a rule condition may use. Use it to build an editor or to validate expressions before saving a rule. The response is a description of the language and does not depend…
- [Get export status](https://docs.mangrovesystems.com/api-reference/exports/get.md): Returns the current status of an export. When completed, includes a temporary download URL valid for 24 hours.
- [List all batches](https://docs.mangrovesystems.com/api-reference/batches/get-all.md): Returns an array of all batches with filtering and sorting capabilities.
- [Retrieve a batch](https://docs.mangrovesystems.com/api-reference/batches/get.md): Returns a specific batch by ID, including underlying input data and allocation to reports. Unlike events and data points, the rule alert fields (`has_rule_alerts` and `rule_alerts`) are returned on this detail response only — the batch list response uses a lighter serializer that omits them.
- [Retrieve all batches on a ledger](https://docs.mangrovesystems.com/api-reference/batches/get-ledger-batches.md): Lists all batches for a specific ledger with filtering and sorting capabilities.
- [Update a batch](https://docs.mangrovesystems.com/api-reference/batches/update.md): Updates a batch's tracking ID, the only editable field on a batch. The tracking ID is free text — commas and spaces are allowed, so a batch covering several deliveries can carry all of their numbers — and it is what the dashboard and reports show to identify the batch. Send an empty string to clear…
- [Update batch inputs](https://docs.mangrovesystems.com/api-reference/batches/update-inputs.md): Edits an existing batch's inputs — the API equivalent of the dashboard's edit-batch flow. Use it to re-attach data points, adjust upstream batch allocations, or skip data point types so they are recorded as `skipped_input` rather than left missing. Each array replaces the current set for that field…
- [Delete a batch](https://docs.mangrovesystems.com/api-reference/batches/delete.md): Deletes a batch.
- [List all evidences for a batch](https://docs.mangrovesystems.com/api-reference/batches/evidences/get-all.md): Returns all evidences associated with a batch through its model run.
- [List all ledgers](https://docs.mangrovesystems.com/api-reference/ledgers/get-all.md): Returns an array of all ledgers with filtering and sorting capabilities.
- [Retrieve a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/get.md): Returns a specific ledger by ID.
- [Create a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/create.md): Creates a new ledger scoped to a project.
- [Update a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/patch.md): Updates a ledger. Cannot update system ledgers.
- [Delete a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/delete.md): Deletes a ledger. Cannot delete system ledgers or ledgers with batches/model runs.
- [Get required inputs for batch generation](https://docs.mangrovesystems.com/api-reference/ledgers/required-inputs.md): Returns the required input data point types for batch generation on this ledger. Requires the ledger to have a model configured.
- [Preview batch generation](https://docs.mangrovesystems.com/api-reference/ledgers/generate-preview.md): Previews what batches would be created for the given time range. Does not create any batches.
- [Create batch generation](https://docs.mangrovesystems.com/api-reference/ledgers/batch-generations.md): Triggers an async batch generation job for the given time range.
- [List all reports](https://docs.mangrovesystems.com/api-reference/reports/get-all.md): Returns an array of all reports with filtering and sorting capabilities.
- [Retrieve a report](https://docs.mangrovesystems.com/api-reference/reports/get.md): Returns a specific report by ID.
- [Create a report](https://docs.mangrovesystems.com/api-reference/reports/create.md): Creates a new report. Requires project_id and quantification_methodology_id.
- [Update a report](https://docs.mangrovesystems.com/api-reference/reports/patch.md): Updates a report. Only draft reports can be updated.
- [Delete a report](https://docs.mangrovesystems.com/api-reference/reports/delete.md): Deletes a report if it is deletable.
- [Submit report to registry](https://docs.mangrovesystems.com/api-reference/reports/submit.md): Submits a report to the registry. Returns an async task. The report must meet all submission requirements.
- [Invite an auditor](https://docs.mangrovesystems.com/api-reference/reports/invite-auditor.md): Gives an external auditor read-only access to one report and emails them an invitation naming it. The auditor signs in to Audit Hub to review the report, its batches, its documents, and its evidence.
- [Revoke an auditor](https://docs.mangrovesystems.com/api-reference/reports/revoke-auditor.md): Withdraws an auditor's access to one report, addressed by email. The report stops being reachable for them on their next request. Access to any other report shared with the same auditor is untouched.
- [List report maps](https://docs.mangrovesystems.com/api-reference/report-maps/get-all.md): Returns paginated report maps for a project. Each report map defines how model nodes map to external registry parameter keys.
- [Get a report map](https://docs.mangrovesystems.com/api-reference/report-maps/get.md)
- [Create a report map](https://docs.mangrovesystems.com/api-reference/report-maps/create.md): Create a report map. Supports nested versions_attributes for creating the full hierarchy (versions, entries, parameter bindings) in one call.
- [Update a report map](https://docs.mangrovesystems.com/api-reference/report-maps/patch.md)
- [Delete a report map](https://docs.mangrovesystems.com/api-reference/report-maps/delete.md)
- [List versions](https://docs.mangrovesystems.com/api-reference/report-map-versions/get-all.md)
- [Get a version](https://docs.mangrovesystems.com/api-reference/report-map-versions/get.md)
- [Create a version](https://docs.mangrovesystems.com/api-reference/report-map-versions/create.md): Creates a new version seeded with copies of the latest version's entries and parameter bindings.
- [Update a version](https://docs.mangrovesystems.com/api-reference/report-map-versions/patch.md)
- [Delete a version](https://docs.mangrovesystems.com/api-reference/report-map-versions/delete.md)
- [List entries](https://docs.mangrovesystems.com/api-reference/report-map-entries/get-all.md): Returns entries with inline parameter_bindings.
- [Get an entry](https://docs.mangrovesystems.com/api-reference/report-map-entries/get.md): Returns entry with inline parameter_bindings.
- [Create an entry](https://docs.mangrovesystems.com/api-reference/report-map-entries/create.md)
- [Update an entry](https://docs.mangrovesystems.com/api-reference/report-map-entries/patch.md)
- [Delete an entry](https://docs.mangrovesystems.com/api-reference/report-map-entries/delete.md)
- [List all models](https://docs.mangrovesystems.com/api-reference/models/get-all.md): Returns an array of all active model versions with filtering and sorting capabilities.
- [Retrieve a model](https://docs.mangrovesystems.com/api-reference/models/get.md): Returns a specific model by ID.
- [Create a model](https://docs.mangrovesystems.com/api-reference/models/create.md)
- [Update a model](https://docs.mangrovesystems.com/api-reference/models/update.md): Update model metadata. Does not modify the model's node tree - use create_version for that.
- [Delete a model](https://docs.mangrovesystems.com/api-reference/models/delete.md): Delete a model. By default, only the latest version is deleted, and it must have no model runs. Use the all_versions parameter to delete all versions of the model at once.
- [Create a new model version](https://docs.mangrovesystems.com/api-reference/models/create-version.md): Create a new version of an existing model with an updated YAML definition. Can only be called on the latest version. The new version inherits the model name and increments the version number.
- [Get model YAML](https://docs.mangrovesystems.com/api-reference/models/get-yaml.md): Generate YAML representation of a model's current node tree.
- [Validate model YAML](https://docs.mangrovesystems.com/api-reference/models/validate-yaml.md): Validate a YAML string against a model's config without persisting. Performs multi-layer validation including YAML syntax, structure, business logic, and simulation readiness.
- [Lint model YAML](https://docs.mangrovesystems.com/api-reference/models/lint-yaml.md): Format and lint YAML content. Reorders keys to follow standard convention and fixes indentation. Does not require a specific model - operates on raw YAML.
- [Get model schema](https://docs.mangrovesystems.com/api-reference/models/get-schema.md): Get a model's schema including required inputs, outputs, and available operators. Useful for discovering what inputs a simulation needs.
- [Simulate a model](https://docs.mangrovesystems.com/api-reference/models/simulate.md): Run a dry-run simulation against a model using provided input values. Does not create a model run or persist results.
- [Get all model runs](https://docs.mangrovesystems.com/api-reference/model-runs/get-all.md): List all model runs for a specific model.
- [Get a model run](https://docs.mangrovesystems.com/api-reference/model-runs/get.md): Get a single model run with its calculations and output data points.
- [Create a model run](https://docs.mangrovesystems.com/api-reference/model-runs/create.md): Create and execute a model run. Provide the time range and the data point IDs to use as inputs. The model's node tree is evaluated against the provided data points.
- [Delete a model run](https://docs.mangrovesystems.com/api-reference/model-runs/delete.md): Delete a model run. Cannot delete while state is "processing".
- [List all orders](https://docs.mangrovesystems.com/api-reference/orders/get-all.md): Returns all orders.
- [Retrieve an order](https://docs.mangrovesystems.com/api-reference/orders/get.md): Returns a specific customer order by ID.
- [The Order object](https://docs.mangrovesystems.com/api-reference/orders/order.md): An Order represents a request made by a customer for credit inventory.
- [Show account settings](https://docs.mangrovesystems.com/api-reference/account/get.md)
- [List custom field definitions](https://docs.mangrovesystems.com/api-reference/custom-field-definitions/get-all.md): Returns custom field definitions for the account. Without `project_id`, only account-wide definitions are returned; pass `project_id` to also include definitions scoped to that project.
- [Retrieve a custom field definition](https://docs.mangrovesystems.com/api-reference/custom-field-definitions/get.md): Returns a specific custom field definition by friendly ID.
- [Create a custom field definition](https://docs.mangrovesystems.com/api-reference/custom-field-definitions/create.md): Creates a custom field definition. Once created, `key`, `value_type`, and `object_type` are immutable. Values are set on the parent record — `custom_field_values` on assets, `field_values` on projects.
- [Update a custom field definition](https://docs.mangrovesystems.com/api-reference/custom-field-definitions/patch.md): Updates a custom field definition. `key`, `value_type`, and `object_type` are immutable. For enum definitions, `enumeration_options` replaces the full list — include existing options you want to keep. A project-scoped definition can be widened to account-wide by clearing `project_id`; narrowing is n…
- [Delete a custom field definition](https://docs.mangrovesystems.com/api-reference/custom-field-definitions/delete.md): Deletes a custom field definition. Rejected with 422 if any record still holds a value for this definition's key.
- [Retrieve an async task](https://docs.mangrovesystems.com/api-reference/async-tasks/get.md)
- [Changelog](https://docs.mangrovesystems.com/changelog.md): Additions and updates to the Mangrove platform.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)