# Mangrove Documentation

## Docs

- [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.
- [Custom Fields for Projects](https://docs.mangrovesystems.com/account-admin/custom-fields.md): Project Custom Fields allow you to extend the Mangrove project data model to capture project-specific information that doesn’t fit into standard fields. This enables each project 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
- [Show account settings](https://docs.mangrovesystems.com/api-reference/account/get.md)
- [Retrieve an async task](https://docs.mangrovesystems.com/api-reference/async-tasks/get.md)
- [Authentication](https://docs.mangrovesystems.com/api-reference/authentication.md): Authenticating with the Mangrove API.
- [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.
- [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.
- [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 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.
- [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.
- [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.
- [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.
- [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).
- [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.
- [Retrieve a data point type](https://docs.mangrovesystems.com/api-reference/data-point-types/get.md): Returns a specific data point type by ID.
- [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.
- [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.
- [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.
- [Delete a datapoint](https://docs.mangrovesystems.com/api-reference/datapoints/delete.md): Deletes a specific datapoint by ID.
- [Retrieve a datapoint](https://docs.mangrovesystems.com/api-reference/datapoints/get.md): Retrieves a specific datapoint by ID.
- [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.
- [Update a datapoint](https://docs.mangrovesystems.com/api-reference/datapoints/patch.md): Update an existing datapoint. An event can be associated with multiple datapoints.
- [Create an event type](https://docs.mangrovesystems.com/api-reference/event-types/create.md): Creates a new event type for a project.
- [Delete an event type](https://docs.mangrovesystems.com/api-reference/event-types/delete.md): Deletes an event type.
- [Retrieve an event type](https://docs.mangrovesystems.com/api-reference/event-types/get.md): Returns a specific event type by ID.
- [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.
- [Update an event type](https://docs.mangrovesystems.com/api-reference/event-types/patch.md): Updates an existing event type.
- [Create an event](https://docs.mangrovesystems.com/api-reference/events/create.md): Creates events to capture ongoing operational data within a specific project boundary.
- [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.
- [Retrieve an event](https://docs.mangrovesystems.com/api-reference/events/get.md): Retrieves a specific event by ID.
- [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.
- [Update an event](https://docs.mangrovesystems.com/api-reference/events/patch.md): Updates a specific event 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.
- [Retrieve an evidence](https://docs.mangrovesystems.com/api-reference/evidence/get.md): Retrieves a specific piece of evidence by ID.
- [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.
- [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 batch generation](https://docs.mangrovesystems.com/api-reference/ledgers/batch-generations.md): Triggers an async batch generation job for the given time range.
- [Create a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/create.md): Creates a new ledger scoped to a project.
- [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.
- [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.
- [Retrieve a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/get.md): Returns a specific ledger by ID.
- [List all ledgers](https://docs.mangrovesystems.com/api-reference/ledgers/get-all.md): Returns an array of all ledgers with filtering and sorting capabilities.
- [Update a ledger](https://docs.mangrovesystems.com/api-reference/ledgers/patch.md): Updates a ledger. Cannot update system ledgers.
- [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.
- [Create a location](https://docs.mangrovesystems.com/api-reference/locations/create.md): Create a new location for the given project.
- [Delete a location](https://docs.mangrovesystems.com/api-reference/locations/delete.md): Destroy a location by id.
- [Retrieve a location](https://docs.mangrovesystems.com/api-reference/locations/get.md): Retrieves a specific location by id.
- [All locations on a project](https://docs.mangrovesystems.com/api-reference/locations/get-all.md): List all locations of a given project.
- [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.
- [Update a location](https://docs.mangrovesystems.com/api-reference/locations/patch.md): Update a specific location by id.
- [MCP Integration](https://docs.mangrovesystems.com/api-reference/mcp-setup.md): Connect your Mangrove data to AI assistants using the Model Context Protocol
- [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".
- [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.
- [Get all model runs](https://docs.mangrovesystems.com/api-reference/model-runs/get-all.md): List all model runs for a specific model.
- [Create a model](https://docs.mangrovesystems.com/api-reference/models/create.md)
- [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.
- [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.
- [Retrieve a model](https://docs.mangrovesystems.com/api-reference/models/get.md): Returns a specific model by ID.
- [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.
- [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.
- [Get model YAML](https://docs.mangrovesystems.com/api-reference/models/get-yaml.md): Generate YAML representation of a model's current node tree.
- [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.
- [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.
- [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.
- [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.
- [Retrieve an order](https://docs.mangrovesystems.com/api-reference/orders/get.md): Returns a specific customer order by ID.
- [List all orders](https://docs.mangrovesystems.com/api-reference/orders/get-all.md): Returns all orders.
- [The Order object](https://docs.mangrovesystems.com/api-reference/orders/order.md): An Order represents a request made by a customer for credit inventory.
- [Pagination](https://docs.mangrovesystems.com/api-reference/pagination.md): How collections are paginated in 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.
- [Rate Limits](https://docs.mangrovesystems.com/api-reference/rate-limits.md): Limits on requests to the Mangrove API.
- [Create a report](https://docs.mangrovesystems.com/api-reference/reports/create.md): Creates a new report. Requires project_id and quantification_methodology_id.
- [Delete a report](https://docs.mangrovesystems.com/api-reference/reports/delete.md): Deletes a report if it is deletable.
- [Retrieve a report](https://docs.mangrovesystems.com/api-reference/reports/get.md): Returns a specific report by ID.
- [List all reports](https://docs.mangrovesystems.com/api-reference/reports/get-all.md): Returns an array of all reports with filtering and sorting capabilities.
- [Update a report](https://docs.mangrovesystems.com/api-reference/reports/patch.md): Updates a report. Only draft reports can be updated.
- [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.
- [Create a static input](https://docs.mangrovesystems.com/api-reference/static-inputs/create.md): Creates a new static input for a project.
- [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.
- [Retrieve a static input](https://docs.mangrovesystems.com/api-reference/static-inputs/get.md): Returns a specific static input by ID.
- [List all static inputs](https://docs.mangrovesystems.com/api-reference/static-inputs/get-all.md): Returns all static inputs 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.
- [Status Codes](https://docs.mangrovesystems.com/api-reference/status-codes.md): Status codes returned by the Mangrove API.
- [API Support](https://docs.mangrovesystems.com/api-reference/support.md): Get Support with the Mangrove API
- [Changelog](https://docs.mangrovesystems.com/changelog.md): Additions and updates to the Mangrove platform.
- [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.
- [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.
- [Connect data sources](https://docs.mangrovesystems.com/data-collection/data-sources.md): Data can be ingested from connected data sources on a project.
- [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 Collection Pathways](https://docs.mangrovesystems.com/data-collection/pathways.md)
- [Request data from external partners](https://docs.mangrovesystems.com/data-collection/request-data.md): Mangrove can be used to request data and documentation from your data partners on a project through email or by sharing a request link.
- [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.
- [Customer Portal](https://docs.mangrovesystems.com/inventory/customer-portal.md): Invite customers into a branded portal to share MRV data for their deliveries.
- [Inventory Fundamentals](https://docs.mangrovesystems.com/inventory/fundamentals.md): Key credit inventory concepts used in Mangrove
- [Getting started](https://docs.mangrovesystems.com/inventory/getting-started.md): Take the following steps to set up your inventory of credits and environmental attributes.
- [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.
- [Retire credits](https://docs.mangrovesystems.com/inventory/retirements.md): Credit retirements can be recorded within Mangrove to keep your inventory up to date.
- [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.
- [Mangrove Overview](https://docs.mangrovesystems.com/overview.md): Your guide to using Mangrove.
- [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
- [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.
- [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…
- [Production Accounting Fundamentals](https://docs.mangrovesystems.com/production-accounting/fundamentals.md): Key production accounting concepts used in Mangrove
- [Generate batches](https://docs.mangrovesystems.com/production-accounting/generate-batches.md): Calculate the ongoing production outputs using collected data.
- [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.
- [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.
- [Configure project locations](https://docs.mangrovesystems.com/production-accounting/locations.md): Track locations within your project boundary where activity is occurring.
- [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.
- [Model Operators](https://docs.mangrovesystems.com/production-accounting/model-expressions.md): Write mathematical and logical operators in Mangrove's models.
- [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.
- [Uncertainty propagation](https://docs.mangrovesystems.com/production-accounting/uncertainty-propagation.md)
- [Reporting Fundamentals](https://docs.mangrovesystems.com/reporting/fundamentals.md): Key reporting concepts used in Mangrove
- [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.
- [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.

## OpenAPI Specs

- [openapi](https://docs.mangrovesystems.com/api-reference/openapi.yaml)