Skip to main content
GET
← Custom Emission Factors Look a record up by its id alone, for example to check the factor behind a custom_ef_record_id in your data. The response adds the record’s database_id.
Beta. Part of the custom emission factors API, currently in beta. The contract may still change before general availability.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa
uuid
required
The record id.Example: c3d4e5f6-a7b8-9012-cdef-ab3456789012

Response

uuid
Record id: the value your data references (e.g. custom_ef_record_id on a waste).
string
Record name.
uuid
Unit of the activity the factor applies to.
uuid
Version the record belongs to.
string
Available values: simple, advanced, full.
array[string]
Categories that can use the record.
boolean
Only enabled records can be used by new data.
boolean
Whether the CO2 factor is reported as biogenic.
number | null
Renewable share (electricity only).
number
Uncertainty grade.
string | null
URL of the first evidence document, if any.
array[object]
Evidence documents: file_id, file_name, file_url, size_kb.
array[object]
One per gas.
uuid
Database the record belongs to.

Common Errors

401 Unauthorized

Missing or invalid API key.

403 Forbidden

LOGGED_USER_NOT_MEMBER: the API key’s user is not a member of the organization in x-organization-id.

404 CUSTOM_RECORD_NOT_FOUND

The record does not exist or is not visible to your organization.

List Records

Records of a version

Update Record

Change a record