Docs
History
Schema
Generate

Filter operations

Access22

Assistant19

Billing6

BillingOps9

Client errors1

Commute surveys22

DataFeeds3

Emissions6

Factor Manage19

Factors1

Partners9

Period close6

PlatformOps10

Reports34

Sandboxes5

Sites17

Supplier portal15

Suppliers18

Uploads17

Workspaces10

post/chat/stream
post/dashboard/layouts
get/dashboard/layouts/latest
get/emissions/source-recordsList fixed source business fields for Dashboard tables
get/health
get/health/ready
get/me
get/me/context
post/metrics/query/datapoints
get/metrics/query/filter-optionsList organization-wide dynamic metrics filter values
get/net-zero/action-catalogueThe catalogue entries that apply, with the bases an action can cut
get/net-zero/action-memosThe workspace's action memos
post/net-zero/action-memosCreate the memo for a year
get/net-zero/action-memos/{year}Read a year's memo with its live fields, reviews and summary
post/net-zero/action-memos/{year}/actionsAdd an action to a year's memo
post/net-zero/action-memos/{year}/reviewsRecord a periodic review of a year's memo
delete/net-zero/actions/{id}Delete an action
patch/net-zero/actions/{id}Edit an action
post/net-zero/actions/{id}/recalculateRe-snapshot an action's base and re-estimate it
get/net-zero/annual-inventoriesList observed emissions for completed calendar years
get/net-zero/baselinesEvery confirmed baseline, newest first
post/net-zero/baselinesConfirm an immutable annual emissions baseline
get/net-zero/baselines/latestRead the latest confirmed baseline for one reporting year
get/net-zero/baselines/{baselineId}/recalculationWhether a confirmed baseline has drifted from the ledger
get/net-zero/electricity-instrumentsContractual instruments in force during a calendar year
get/net-zero/inventory-previewPreview observed emissions for one reporting year
get/net-zero/manual-inventoriesThe organization's hand-entered years, newest first
put/net-zero/manual-inventories/{year}Store a year's hand-entered emissions
delete/net-zero/manual-inventories/{year}Remove a year's hand-entered emissions
get/net-zero/profileThe organization profile SBTi CNZS V2.0 categorises by
put/net-zero/profileStore the organization profile
get/net-zero/reference-factors/statusWhether the Scope 2 reference factors are current
get/net-zero/supplier-engagementSupplier emissions by SBTi status
get/net-zero/target-setsThe organization's target sets, newest first
post/net-zero/target-setsSave a target set as the active one
get/net-zero/target-sets/activeRead the active target set, judged against its SBTi rulebook today
post/net-zero/target-sets/previewJudge a draft target set without saving it
get/net-zero/targets/currentRead the organization's current custom target
put/net-zero/targets/currentCreate or update the organization's current custom target
get/organization/settingsThe selected business organization's settings
put/organization/settingsStore the selected business organization's settings
post/overview/dashboard/autosavesAutosave the Overview dashboard the caller is editing, as a private draft
post/overview/widget-draftsDraft Overview dashboard widgets from a natural-language request
post/overview/widget-drafts/{requestId}/cancelStop a widget draft request the user no longer wants
get/pcf/archived-productsList the organization's archived PCF products
delete/pcf/archived-products/{productId}Permanently delete an archived PCF product
post/pcf/archived-products/{productId}/restoreRestore an archived PCF product
post/pcf/bom-scanScan a BOM file for the product it describes
get/pcf/calculations/{calculationId}Read one saved calculation snapshot
get/pcf/conversion-itemsList the item vocabulary a BOM line can be described as
get/pcf/factor-libraryDescribe the factor library PCF calculations use
post/pcf/factor-searchSearch the PCF factor library for a BOM line
get/pcf/factors/{factorEntryId}/conversionsList the reviewed conversions from a BOM line's unit to a factor's unit
get/pcf/productsList the organization's PCF products
post/pcf/productsCreate a PCF product
get/pcf/products/{productId}Read a PCF product with its bill of materials
put/pcf/products/{productId}Replace a PCF product's details
delete/pcf/products/{productId}Archive a PCF product
put/pcf/products/{productId}/bomReplace a PCF product's bill of materials
get/pcf/products/{productId}/bom-importsList a product's BOM file imports
post/pcf/products/{productId}/bom-importsUpload a BOM file and read it into reviewable lines
get/pcf/products/{productId}/bom-imports/{importId}Read a BOM import with its lines and factor candidates
delete/pcf/products/{productId}/bom-imports/{importId}Discard a BOM import that has not been applied
post/pcf/products/{productId}/bom-imports/{importId}/applyWrite an import's lines into the product's BOM
post/pcf/products/{productId}/bom-imports/{importId}/reanalyzeRead the stored BOM file again
put/pcf/products/{productId}/bom-imports/{importId}/reviewSave the user's review of an import's lines
get/pcf/products/{productId}/calculationsList a product's saved calculations
post/pcf/products/{productId}/calculationsCalculate a product's footprint and store it as an immutable snapshot
post/pcf/products/{productId}/calculations/previewCalculate a product's footprint from its saved BOM without storing it
get/pcf/products/{productId}/source-fileDownload the BOM file a product was created from
get/uploads
post/uploads
get/uploads/import-settings
get/uploads/templates
get/uploads/{id}
delete/uploads/{id}
post/uploads/{id}/submit
post/uploads/{id}:download-url
get/utility/insightsThe latest generated utility insights for a year (cache only)
post/utility/insightsGenerate utility insights for a year
post/utility/insights/{requestId}/cancelStop a utility insights request the user no longer wants
post/utility/seriesMonthly utility cost, energy and carbon by resource
get/waste/query/emission-factors
post/waste/query/kpi
get/waste/query/raw-rows
post/webhooks/clerk

Changes to GET /health/ready

get/health/ready

Oct 11, 202674b67002e593 Revision changes
- info
  endpoint added