API Reference

List impact recon records

get
https://api.ekko.earth/v3/funds/allocations/impact

Retrieve a paginated, filterable list of environmental impact records per funds allocation.

Returns what impact was delivered, to which project or impact partner, in what quantity, and at what cost. Reversal records are included when they fall within the requested date range, identified by reversal: true with all amounts negated.

amounts at the allocation level mirrors the quote amounts structure, enabling direct quote-vs-actuals comparison.

Query Params
date-time
required

Inclusive lower bound of the date range (ISO 8601). Must be before dateTimeTo.

date-time
required

Exclusive upper bound of the date range (ISO 8601). Must be after dateTimeFrom.

string

Filter by consumer reference.

uuid

Filter by impact partner.

uuid

Filter by funds organisation. Must be within the authenticated organisation's hierarchy.

integer
1 to 100

Number of records to return.

uuid

Cursor for forward pagination (based on fundsAllocationId).

uuid

Cursor for backward pagination (based on fundsAllocationId).

Responses

Updated 16 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 16 days ago