Skip to main content
GET
← Custom Emission Factors The records of a version, sorted by name by default, with search and offset paging.
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 database id.Example: 5f1c2e7a-3b4d-4e8f-9a01-2c3d4e5f6a7b
uuid
required
The version id (id of the version).Example: 7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d
Records whose name contains this text, ignoring case and accents.Example: packaging
integer
default:"0"
Records to skip.
integer
default:"50"
Records to return, between 1 and 200.
string
Available values: name, category, unit_id, co2e, co2, ch4, n2o, has_attachments.
string
default:"asc"
Available values: asc, desc.

Response

array[object]
The records, with the fields of Get Record.
integer
Records matching the filters.
integer
The offset applied.
integer
The limit applied.

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 Not Found

CUSTOM_DATABASE_NOT_FOUND or CUSTOM_VERSION_NOT_FOUND: not visible to your organization.

Get Record

One record by id

Create Record

A new emission factor