API docs by Redocly

EasyLCA Public API (1.0.0)

Documentation for the public HTTP API for EasyLCA. The API follows the JSON:API specification (media type application/vnd.api+json, version 1.0). All operations listed here are served under /api/public-v1.

Authentication: Bearer token. Create it from the Organization Settings page in the EasyLCA web app (app.easylca.ai/my-organization).

Errors: Validation and domain errors use JSON:API error documents (errors[] with status, title, detail, optional source.pointer).

Note: lat / long on locations and similar decimals may appear as strings in JSON responses.

Stakeholders

Stakeholder collection and resource; related resources and relationship linkage URLs.

List stakeholders

Paginated list of stakeholders for the authenticated organization.

Authorizations:
bearerAuth
query Parameters
include
string
Example: include=locations,custom-fields

Comma-separated relationship paths to include in included. Examples for stakeholders: locations, custom-fields, stakeholder-notes, stakeholder-files, stakeholder-requests, stakeholder-action-plans, category (and other registered includes).

sort
string
Example: sort=name

Sort fields (comma-separated). Registered sortable attributes include email, name, organization_name, created_at, updated_at (prefix with - for descending).

page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated stakeholder ids to filter the index (WhereIdIn).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "included": [
    ],
  • "links": { },
  • "meta": { }
}

Create stakeholder

Creates a stakeholder. Optional custom_fields in attributes creates nested custom field rows. If custom_fields was provided, the 201 response typically includes those resources under included (effective include=custom-fields is merged server-side). You may also pass include for other relationships (e.g. locations); server merges custom-fields when applicable.

File custom fields: upload each file first with
POST /public-v1/stakeholders/-actions/custom-field-file-upload (multipart field file), then include an entry with field_type: file and value set to the returned meta.data.path. See that operation and schema StakeholderAttributes.custom_fields for validation rules, org scoping, and 24-hour expiry of unused temp uploads.

Authorizations:
bearerAuth
query Parameters
include
string
Example: include=locations,custom-fields

Comma-separated relationship paths to include in included. Examples for stakeholders: locations, custom-fields, stakeholder-notes, stakeholder-files, stakeholder-requests, stakeholder-action-plans, category (and other registered includes).

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Get stakeholder

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

query Parameters
include
string
Example: include=locations,custom-fields

Comma-separated relationship paths to include in included. Examples for stakeholders: locations, custom-fields, stakeholder-notes, stakeholder-files, stakeholder-requests, stakeholder-action-plans, category (and other registered includes).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Update stakeholder

The custom_fields attribute must not be sent on update (422 if present).

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

query Parameters
include
string
Example: include=locations,custom-fields

Comma-separated relationship paths to include in included. Examples for stakeholders: locations, custom-fields, stakeholder-notes, stakeholder-files, stakeholder-requests, stakeholder-action-plans, category (and other registered includes).

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Delete stakeholder

Deletes the stakeholder.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

List locations (related resource)

Full stakeholder-locations resources for this stakeholder.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Locations relationship linkage

Resource identifier objects for the locations relationship.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "links": { }
}

List custom fields (related resource)

Full custom-fields resources linked to this stakeholder.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Custom fields relationship linkage

Resource identifier objects for the custom-fields relationship.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "links": { }
}

Stakeholder category (related resource)

Full stakeholder-categories resource linked to this stakeholder.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Category relationship linkage

Resource identifier object for the category relationship.

Authorizations:
bearerAuth
path Parameters
stakeholder
required
string

Stakeholder id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "links": { }
}

Upload file for stakeholder custom fields (temporary)

Multipart upload used to stage a file before creating a stakeholder with a file-type custom field.

Send a single part named file. Allowed types include common images, PDF, Office documents, CSV, and plain text. Maximum upload size is 50 MB.

The JSON:API response meta.data.path is the S3 key you must pass as attributes.custom_fields[].value when field_type is file on POST /public-v1/stakeholders.

Uploaded files that are not linked to a created stakeholder are removed automatically after 24 hours. Each upload must be used with a distinct S3 object key if you send multiple file custom fields in one create request.

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>

File to upload (field name must be file).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "meta": {
    }
}

Stakeholder categories

Global stakeholder category lookup (read-only). Use for resolving category on stakeholders and for include=category on stakeholder reads.

List stakeholder categories

Global lookup values for stakeholder category (read-only). Supports JSON:API pagination (page[number], page[size]) and filter[id] (comma-separated ids).

Authorizations:
bearerAuth
query Parameters
page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated stakeholder category ids to filter the index (WhereIdIn).

sort
string
Example: sort=title

Sort fields (comma-separated). Registered sortable attributes includes title (prefix with - for descending).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "links": { }
}

Get stakeholder category

Authorizations:
bearerAuth
path Parameters
stakeholder_category
required
string

Stakeholder category id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Stakeholder locations

Create, read, and delete stakeholder locations.

Create stakeholder location

Requires attributes.address (non-empty).

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Get stakeholder location

Authorizations:
bearerAuth
path Parameters
stakeholder_location
required
string

Stakeholder location id.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Delete stakeholder location

Authorizations:
bearerAuth
path Parameters
stakeholder_location
required
string

Stakeholder location id.

Responses

Related stakeholder resource

Returns the parent stakeholder as the primary data resource.

Authorizations:
bearerAuth
path Parameters
stakeholder_location
required
string

Stakeholder location id.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Stakeholder relationship linkage

Authorizations:
bearerAuth
path Parameters
stakeholder_location
required
string

Stakeholder location id.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "links": { }
}

LCA products

LCA product CRUD, template-based phase seeding, image upload, and product custom fields.

List LCA products

Paginated list of LCA products for the authenticated organization.

Authorizations:
bearerAuth
query Parameters
include
string
Example: include=phases,custom-fields

Comma-separated relationship paths to include in included. For LCA products: phases, custom-fields, user. Nested paths under phases are also supported, e.g. phases.phase-items, phases.framework.

page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated LCA product ids to filter the index (WhereIdIn).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}

Create LCA product

Creates an LCA product. template is required and seeds assessment phases (titles, icons, and epd_module_code when defined on the template). Discover available templates and their phases with GET /public-v1/lca-product-templates.

Optional custom_fields creates nested custom field rows. For file fields, upload first via POST /public-v1/lca-products/-actions/custom-field-file-upload (multipart field file), and set value to meta.data.path. See that operation and schema LcaProductAttributes.custom_fields for validation rules, org scoping, and 24-hour expiry of unused temp uploads.

Pass include (e.g. phases) to return related resources under included in the 201 response.

Typical next steps after create:

  1. GET /public-v1/lca-products/{id}/phases (or create additional phases with EPD codes)
  2. Add phase line items via POST /public-v1/phase-items
Authorizations:
bearerAuth
query Parameters
include
string
Example: include=phases,custom-fields

Comma-separated relationship paths to include in included. For LCA products: phases, custom-fields, user. Nested paths under phases are also supported, e.g. phases.phase-items, phases.framework.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}

Get LCA product

Single product resource. Response meta.unitName is the preferred LCIA unit label. Use include to embed related resources (e.g. phases, custom-fields) under included.

Authorizations:
bearerAuth
path Parameters
lca_product
required
string

LCA product id (JSON:API resource id).

query Parameters
include
string
Example: include=phases,custom-fields

Comma-separated relationship paths to include in included. For LCA products: phases, custom-fields, user. Nested paths under phases are also supported, e.g. phases.phase-items, phases.framework.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}

Update LCA product

Updates product attributes. Rejected when the product is locked (locked_at set). template, image, and nested custom_fields are not accepted on update (use image upload action / custom-fields resource instead).

Authorizations:
bearerAuth
path Parameters
lca_product
required
string

LCA product id (JSON:API resource id).

query Parameters
include
string
Example: include=phases,custom-fields

Comma-separated relationship paths to include in included. For LCA products: phases, custom-fields, user. Nested paths under phases are also supported, e.g. phases.phase-items, phases.framework.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}

Delete LCA product

Soft-deletes the product when not locked.

Authorizations:
bearerAuth
path Parameters
lca_product
required
string

LCA product id (JSON:API resource id).

Responses

List custom fields for product

Related custom-fields resources for the product.

Authorizations:
bearerAuth
path Parameters
lca_product
required
string

LCA product id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Upload product image

Multipart upload named image. Allowed types: jpeg, jpg, png, svg, webp. Maximum size 5 MB.

On success the product’s stored image path is updated. Response meta.path is the S3 key; subsequent GET of the product returns a temporary signed URL in attributes.image.

Authorizations:
bearerAuth
path Parameters
lca_product
required
string

LCA product id (JSON:API resource id).

Request Body schema: multipart/form-data
required
image
required
string <binary>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "meta": {
    }
}

Upload file for product custom fields (temporary)

Multipart upload used to stage a file before creating an LCA product with a file-type custom field.

Send a single part named file. Allowed types include common images, PDF, Office documents, CSV, and plain text. Maximum size 5 MB.

The JSON:API response meta.data.path is the S3 key you must pass as attributes.custom_fields[].value when field_type is file on POST /public-v1/lca-products.

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "meta": {
    }
}

LCA product templates

Read-only catalog of assessment templates. Use when choosing attributes.template on product create; each template includes the phases it will seed.

List LCA product templates

Read-only catalog of product assessment templates.

Use id / attributes.name as attributes.template when creating an LCA product. Each entry includes attributes.phases — the phases (title, description, epd_module_code, icon) that will be created for a product using that template.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Get LCA product template

Fetch a single template by name (e.g. a1-a3, cradle-to-gate, start-from-scratch).

Authorizations:
bearerAuth
path Parameters
lcaProductTemplate
required
string

LCA product template name / resource id (e.g. start-from-scratch, a1-a3). Same values as attributes.template on product create.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

EPD module codes

Read-only EN 15804 / EPD lifecycle module catalog (enum-backed, not a database table). Use when setting epd_module_code on phases.

List EPD module codes

Read-only catalog of standardized EN 15804 / EPD lifecycle modules (plus CUSTOM).

Use id / attributes.code as epd_module_code when creating or assigning an EPD module code on phases.

Order is stable (A1–A5, B1–B7, C1–C4, D, CUSTOM). Grouping for UIs should use stage / stage_label.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Get EPD module code

Fetch a single catalog entry by module code (e.g. A1, CUSTOM).

Authorizations:
bearerAuth
path Parameters
epdModuleCode
required
string

EPD module code / resource id (e.g. A1, CUSTOM). Same values as attributes.code on epd-module-codes resources.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Phases

LCA product assessment phases. Creating a phase requires epd_module_code (see EPD module codes) and a framework relationship. Legacy phases may have a null code until assigned once; the code is then immutable.

List phases for an LCA product

Related phases for a product (/lca-products/{id}/phases). Each phase may include epd_module_code (null for legacy unassigned phases).

Authorizations:
bearerAuth
path Parameters
lca_product
required
string

LCA product id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Create phase

Create a phase on an LCA product/framework. epd_module_code is required. Allowed codes are listed by GET /public-v1/epd-module-codes. Multiple phases may share the same module code. Product and framework relationships are required and cannot be changed later.

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Get phase

Single phase resource (includes epd_module_code when set). Use include to embed related resources under included (e.g. phase-items).

Authorizations:
bearerAuth
path Parameters
phase
required
string

Phase id (JSON:API resource id).

query Parameters
include
string
Example: include=phase-items

Comma-separated relationship paths to include in included. For phases: phase-items, product, framework.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Update phase

Update title, description, and/or icon. Product/framework cannot be changed.

If epd_module_code is still null (legacy phase), assigning a valid code is required before other edits are accepted. After assignment the code is immutable.

Authorizations:
bearerAuth
path Parameters
phase
required
string

Phase id (JSON:API resource id).

query Parameters
include
string
Example: include=phase-items

Comma-separated relationship paths to include in included. For phases: phase-items, product, framework.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "included": [
    ]
}

Delete phase

Authorizations:
bearerAuth
path Parameters
phase
required
string

Phase id (JSON:API resource id).

Responses

List phase items for phase

Related assessment line items (phase-items) for this phase.

Authorizations:
bearerAuth
path Parameters
phase
required
string

Phase id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Phase items

Assessment line items within a phase (quantity of an LCA object or custom dataset).

Create phase item (assessment line item)

Adds an inventory item to a phase. Requires relationships:

  • phase — target phase (must belong to your organization)
  • item — either lca-objects or lca-custom-datasets (org-scoped)
  • optional parent — nest under another phase-item in the same phase

volume is required. Title/unit/impact are resolved from the linked item on read.

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "meta": {
    }
}

Get phase item

Authorizations:
bearerAuth
path Parameters
phase_item
required
string

Phase-item id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "meta": {
    }
}

Update phase item

Update volume only. Changing phase or item is not allowed.

Authorizations:
bearerAuth
path Parameters
phase_item
required
string

Phase-item id (JSON:API resource id).

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "meta": {
    }
}

Delete phase item

Authorizations:
bearerAuth
path Parameters
phase_item
required
string

Phase-item id (JSON:API resource id).

Responses

LCA dataset categories

Read-only catalog of categories for lca-custom-datasets. List these to choose relationships.category when creating or updating custom datasets. Optional language=en|sv|es returns a single localized title/description.

List LCA dataset categories

Read-only catalog of categories for lca-custom-datasets. Creating/updating a custom dataset requires a category relationship to one of these ids.

Pass optional language (en, sv, or es; default en) to receive localized title and description.

Authorizations:
bearerAuth
query Parameters
page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated LCA dataset category ids to filter the index (WhereIdIn).

language
string
Default: "en"
Enum: "en" "sv" "es"

Locale for localized title and description attributes on category resources. Defaults to en when omitted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Get LCA dataset category

Authorizations:
bearerAuth
path Parameters
lca_dataset_category
required
string

LCA dataset category id (JSON:API resource id).

query Parameters
language
string
Default: "en"
Enum: "en" "sv" "es"

Locale for localized title and description attributes on category resources. Defaults to en when omitted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

LCA custom datasets

Create, read, update, and delete custom datasets for linking as item on phase-items. Creating a dataset requires a category relationship (see LCA dataset categories).

List custom datasets

Organization-scoped custom datasets that can be linked as item on phase-items with type: lca-custom-datasets.

Authorizations:
bearerAuth
query Parameters
page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated custom dataset ids to filter the index (WhereIdIn).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Create custom dataset

Creates an organization-scoped custom dataset that can later be linked from a phase-item. Requires a category relationship to an existing lca-dataset-categories resource (list via GET /lca-dataset-categories). dataset_type defaults to custom_dataset when omitted. Impact indicators are not writable through the API.

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Get custom dataset

Show an organization custom dataset. Use the id as item when creating a phase-item with type: lca-custom-datasets.

Authorizations:
bearerAuth
path Parameters
lca_custom_dataset
required
string

Custom dataset id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Update custom dataset

Authorizations:
bearerAuth
path Parameters
lca_custom_dataset
required
string

Custom dataset id (JSON:API resource id).

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Delete custom dataset

Authorizations:
bearerAuth
path Parameters
lca_custom_dataset
required
string

Custom dataset id (JSON:API resource id).

Responses

LCA object categories

Read-only catalog of categories for lca-objects. List these to choose relationships.category when creating or updating objects. Optional language=en|sv|es returns a single localized title/description; key remains the stable database code.

List LCA object categories

Read-only catalog of categories for lca-objects. Creating/updating an object requires a category relationship to one of these ids.

Pass optional language (en, sv, or es; default en) to receive localized title and description from application translations. The stable database code is returned as key.

Authorizations:
bearerAuth
query Parameters
page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated LCA object category ids to filter the index (WhereIdIn).

language
string
Default: "en"
Enum: "en" "sv" "es"

Locale for localized title and description attributes on category resources. Defaults to en when omitted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Get LCA object category

Authorizations:
bearerAuth
path Parameters
lca_object_category
required
string

LCA object category id (JSON:API resource id).

query Parameters
language
string
Default: "en"
Enum: "en" "sv" "es"

Locale for localized title and description attributes on category resources. Defaults to en when omitted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

LCA objects

Organization inventory / process objects that can be linked as item on phase-items. Creating an object requires a category relationship (see LCA object categories).

List LCA objects

Inventory / process objects available to link as item on phase-items. Scoped to the authenticated organization.

Authorizations:
bearerAuth
query Parameters
page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

filter[id]
string

Comma-separated LCA object ids to filter the index (WhereIdIn).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Create LCA object

Creates an organization-scoped LCA object that can later be linked from a phase-item. Requires a category relationship to an existing lca-object-categories resource (list via GET /lca-object-categories).

Authorizations:
bearerAuth
Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "meta": {
    }
}

Get LCA object

Authorizations:
bearerAuth
path Parameters
lca_object
required
string

LCA object id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "meta": {
    }
}

Update LCA object

Authorizations:
bearerAuth
path Parameters
lca_object
required
string

LCA object id (JSON:API resource id).

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "meta": {
    }
}

Delete LCA object

Authorizations:
bearerAuth
path Parameters
lca_object
required
string

LCA object id (JSON:API resource id).

Responses

LCA frameworks

Read-only frameworks required when creating phases (relationships.framework).

List LCA frameworks

Read-only framework catalog. Creating a phase requires a framework relationship.

Authorizations:
bearerAuth
query Parameters
page[number]
integer >= 1

Page number for stakeholder index (JSON:API page object).

page[size]
integer >= 1

Page size for stakeholder index.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": [
    ]
}

Get LCA framework

Authorizations:
bearerAuth
path Parameters
lca_framework
required
string

LCA framework id (JSON:API resource id).

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Custom fields

Read, update, and delete custom field records scoped to the token’s organization.

Get custom field

Scoped to custom fields for the token’s organization.

Authorizations:
bearerAuth
path Parameters
custom_field
required
string

Custom field id.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Update custom field

Updatable attributes: name, value. field_type is read-only; sending a different field_type in the request document yields 422. For field_type: file, a new non-empty value must refer to an existing S3 object key.

Authorizations:
bearerAuth
path Parameters
custom_field
required
string

Custom field id.

Request Body schema: application/vnd.api+json
required
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    },
  • "data": {
    }
}

Delete custom field

Authorizations:
bearerAuth
path Parameters
custom_field
required
string

Custom field id.

Responses