Skip to main content
GET
/
v1
/
waste-water-treatments
/
{wwt_id}
/
detail
Get Waste Water Treatment by ID
const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/waste-water-treatments/{wwt_id}/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "type": "<string>",
  "status": "<string>",
  "invoice_id": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "facility_id": {},
  "quantity": 123,
  "base_quantity": 123,
  "m3_water_out": 123,
  "kg_sludge": 123,
  "percentage": 123,
  "co2e": {},
  "co2e_biomass": 123,
  "unit": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>"
  },
  "user": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>"
  },
  "uploaded_by": {},
  "source_invoice_id": "<string>",
  "file_url": {},
  "linked_projects": {},
  "facility_percentages": {},
  "created_at": {}
}

Documentation Index

Fetch the complete documentation index at: https://code.dcycle.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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

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

​
Path Parameters

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

​
Response

​
id
string
Unique identifier (UUID) for the WWT record. Use this as waste_water_treatment_id in DELETE /api/v1/waste_water_treatments/.
​
type
string
Always "waste_water_treatment"
​
status
string
Processing status: uploaded, active, loading, or error
​
invoice_id
string
Identification name or invoice number of the WWT record
​
start_date
date
Start date of the treatment period
​
end_date
date
End date of the treatment period
​
facility_id
string | null
UUID of the facility this WWT belongs to
​
quantity
number
Volume of water entering treatment, in m³
​
base_quantity
number
Volume of water exiting treatment, in m³
​
m3_water_out
number
Same as base_quantity — water output volume in m³
​
kg_sludge
number
Mass of sludge produced, in kg
​
percentage
number
Percentage factor (always 1 for WWT records)
​
co2e
number | null
CO2 equivalent emissions in kg CO2e. Populated asynchronously after record activation.
​
co2e_biomass
number
Biogenic CO2 emissions in kg CO2e
​
unit
object
Unit of measurement (always cubic meters for WWT)
​
user
object | null
User who uploaded or created the record
​
uploaded_by
string | null
UUID of the user who created the record
​
source_invoice_id
string
Internal source record UUID (matches id for WWT records)
​
file_url
string | null
Download URL for any linked import file
​
linked_projects
array[object]
Projects this WWT record is linked to
​
facility_percentages
array[object]
Facility distribution breakdown (always empty for WWT records)
​
created_at
datetime
Timestamp when the record was created

​
Example

curl -X GET "https://api.dcycle.io/v1/waste-water-treatments/550e8400-e29b-41d4-a716-446655440000/detail" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

​
Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "type": "waste_water_treatment",
  "status": "active",
  "invoice_id": "WWT-2025-001",
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "facility_id": "660e8400-e29b-41d4-a716-446655440000",
  "quantity": 12500.0,
  "base_quantity": 12000.0,
  "m3_water_out": 12000.0,
  "kg_sludge": 850.0,
  "percentage": 1,
  "co2e": 4521.3,
  "co2e_biomass": 0.0,
  "unit": {
    "id": "...",
    "name": "cubic_meter_(m3)",
    "type": "volume"
  },
  "user": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "first_name": "Ana",
    "last_name": "García",
    "email": "ana.garcia@company.com"
  },
  "uploaded_by": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "source_invoice_id": "550e8400-e29b-41d4-a716-446655440000",
  "file_url": null,
  "linked_projects": [],
  "facility_percentages": [],
  "created_at": "2025-02-01T10:30:00Z"
}

​
Common Errors

​
401 Unauthorized

Cause: Missing or invalid API key 
{
  "detail": "Invalid API key",
  "code": "INVALID_API_KEY"
}
Solution: Verify your API key is valid and active.

​
403 Forbidden

Cause: The WWT record belongs to a different organization 
{
  "detail": "Waste water treatment does not belong to this organization",
  "code": "WWT_ACCESS_DENIED"
}
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 
{
  "detail": "Waste water treatment not found",
  "code": "WWT_NOT_FOUND"
}
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