Skip to main content
GET
Get Waste Water Treatment by ID
Retrieve a single waste water treatment (WWT) record with enriched data: CO2e emissions, the user who uploaded it, and any linked projects. Useful to inspect a specific record before deleting or auditing it.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the waste water treatment recordExample: 550e8400-e29b-41d4-a716-446655440000

Response

string
Unique identifier (UUID) for the WWT record. Use this as waste_water_treatment_id in DELETE /api/v1/waste_water_treatments/{id}.
string
Always "waste_water_treatment"
string
Processing status: uploaded, active, loading, or error
string
Identification name or invoice number of the WWT record
date
Start date of the treatment period
date
End date of the treatment period
string | null
UUID of the facility this WWT belongs to
number
Volume of water entering treatment, in m³
number
Volume of water exiting treatment, in m³
number
Same as base_quantity — water output volume in m³
number
Dry sludge produced, in kg of dry matter
number | null
Organic load of the influent, WWT line (kg/m³): BOD, or COD when the plant’s lines are dqo_industrial (see BOD or COD)
number | null
Organic load of the sludge, sludge line (kg per kg of dry sludge): BOD, or COD when the plant’s lines are dqo_industrial
number | null
Organic load of the effluent, WWD line (kg/m³): BOD, or COD when the plant’s lines are dqo_industrial
number | null
Nitrogen concentration of the influent, WWT line (kg N/m³)
number | null
Nitrogen concentration of the effluent, WWD line (kg N/m³)
number | null
CH4 recovered in the WWT line (kg). null: none recorded, calculated as 0.
number | null
CH4 recovered in the sludge line (kg). null: none recorded, calculated as 0.
number
Percentage factor (always 1 for WWT records)
number | null
CO2 equivalent emissions in kg CO2e. Populated asynchronously after record activation.
number
Biogenic CO2 emissions in kg CO2e
object
Unit of measurement (always cubic meters for WWT)
object | null
User who uploaded or created the record
string | null
UUID of the user who created the record
string
Internal source record UUID (matches id for WWT records)
string | null
Download URL for any linked import file
string | null
Original name of the attached document, when it was sent with one
string | null
The raw file of the spreadsheet import that created the record, to open it as the record’s source. null on a record created by hand or through the API (its attachment is file_url)
string | null
Where the record comes from: manual (the app’s form), api (sent with an API key) or bulk_file (a spreadsheet import), the values invoices use. null on older records created by hand or through the API
object | null
The document attached to the record (attachment_file_id), or null. Not the file the record was imported or read from (file_id); on an older record typed in the form, its file_url, with file_id null. A file deleted or moved to the trash is no longer attached.
object | null
Confidence (0 to 1) of the reading of the plant report the record was read from (source pdf), per field as it was read (influent_volume, start_date…). null when nobody read one: typed in the form, sent through the API or imported from a spreadsheet.
array[object]
Projects this WWT record is linked to
array[object]
Facility distribution breakdown (always empty for WWT records)
datetime
Timestamp when the record was created

Example

Successful Response

Common Errors

401 Unauthorized

Cause: Missing or invalid API key
Solution: Verify your API key is valid and active.

403 Forbidden

Cause: The WWT record belongs to a different organization
Solution: Verify the wwt_id belongs to the organization indicated in x-organization-id.

404 Not Found

Cause: No WWT record exists with that UUID
Solution: Check the wwt_id. You can list all WWT records for a facility using the list endpoint.

List Waste Water Treatments

Retrieve all WWT records for a facility

Delete Waste Water Treatment

Delete a single WWT record by ID