Skip to main content
GET
/
v1
/
lca
/
portfolio
/
{lca_id}
Get LCA Portfolio
const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/lca/portfolio/{lca_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "description": {},
  "impact_categories": {},
  "final_product_id": {},
  "unit_id": "<string>",
  "value": 123,
  "start_date": "<string>",
  "end_date": "<string>",
  "status": "<string>",
  "created_at": {},
  "updated_at": {}
}

Get LCA Portfolio

Returns the details of a specific LCA portfolio, including its name, date range, functional unit, impact categories, and current status.

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

lca_id
string
required
UUID of the LCA portfolioExample: 550e8400-e29b-41d4-a716-446655440000

Response

id
string
UUID of the LCA portfolio
organization_id
string
UUID of the organization that owns this portfolio
name
string
Name of the LCA portfolio
description
string | null
Optional description of the portfolio
impact_categories
array[string]
List of impact category identifiers included in this assessment (e.g. "gwp", "ap", "ep")
final_product_id
string | null
UUID of the primary output product (co-product), if set
unit_id
string
Functional unit identifier (e.g. "kg", "unit")
value
number
Functional unit quantity
start_date
date
Start date of the assessment period (YYYY-MM-DD)
end_date
date
End date of the assessment period (YYYY-MM-DD)
status
string
Current status of the portfolio
created_at
datetime
When the portfolio was created (ISO 8601)
updated_at
datetime | null
When the portfolio was last updated (ISO 8601)

Example

curl -X GET "https://api.dcycle.io/v1/lca/portfolio/${LCA_ID}" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
  "name": "Product A - Environmental Impact 2024",
  "description": "Full cradle-to-gate LCA for Product A",
  "impact_categories": ["gwp", "ap", "ep", "pocp", "adp"],
  "final_product_id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "unit_id": "kg",
  "value": 1.0,
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "status": "active",
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-06-20T14:30:00Z"
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: LCA portfolio not found or doesn’t belong to your organization
{"detail": "LCA Portfolio not found"}

List LCA Portfolios

Browse all LCA portfolios

LCA Dashboard

Get environmental impact results