Skip to main content

​
Projects API

The Projects API lets you link and unlink entities to projects, enabling project-scoped emissions views and reports. Once entities are linked to a project, all project-level endpoints (reports, filters, summaries) automatically scope their results to those linked entities.
New API: These endpoints are part of the new API architecture.

​
Supported Entity Types

All linking endpoints accept an entity_type field that determines which junction table is used:
entity_type valueDescription
logistic_requestsShipment legs
logistic_rechargesFuel consumption records
logistic_packagesMulti-leg packages
invoicesEnergy/utility invoices
file_readingsMeter readings from uploaded files

​
Available Endpoints

Link Entities

Link up to 100 entities by ID to a project

Unlink Entities

Remove entity-project associations

Link by Filters

Bulk-link all entities matching a filter query

​
Common Use Cases

Use Link Entities when you know the exact IDs — e.g. after a bulk import returns a list of created IDs, link them all to the current project.

​
Associate historical data in bulk

Use Link by Filters to associate all invoices from a given facility and date range, or all logistics requests for a specific client, without fetching and enumerating individual IDs.

​
Remove incorrectly linked records

Use Unlink Entities to remove associations without deleting the underlying records. The entity continues to exist org-wide; it just loses its project-level association.