/
GR
greentally
/
ESGAI API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
1
Docs
History
Schema
Filter operations
Access
22
Assistant
19
Billing
6
BillingOps
9
Client errors
1
Commute surveys
22
get
/commute-surveys
List the organization's employee commuting surveys, newest first
post
/commute-surveys
Create a draft survey from a template or a form (default workspace only)
post
/commute-surveys/drafts
Draft a survey form from a plain-language description (default workspace only)
post
/commute-surveys/drafts/{requestId}/cancel
Stop a survey draft request the user no longer wants
get
/commute-surveys/templates
The ready-made employee commuting survey forms
get
/commute-surveys/{surveyId}
Get one survey (never carries the share link)
put
/commute-surveys/{surveyId}
Edit a survey (a draft takes everything; an open survey keeps its form; a closed one takes nothing)
post
/commute-surveys/{surveyId}/close
Close an open survey
get
/commute-surveys/{surveyId}/link
The survey's share link (a bearer URL; open or closed surveys only)
post
/commute-surveys/{surveyId}/publish
Open a draft survey and mint its share link
get
/commute-surveys/{surveyId}/recipients
The survey's people, their status and the counts (personal links; default workspace only; no-store)
post
/commute-surveys/{surveyId}/recipients
Add people (email, optional name; at most 5000 per survey). Invalid, repeated and listed emails are skipped and reported
post
/commute-surveys/{surveyId}/recipients/invite
Invite everyone not yet invited (or the given ids). greentally emails each person their link within the daily limit; self only marks them invited
post
/commute-surveys/{surveyId}/recipients/links-export
Name, email and personal link of everyone who hasn't answered (CSV, base64); marks the not yet invited "Invited (self)". no-store
post
/commute-surveys/{surveyId}/recipients/remind
Email everyone GreenTally invited who hasn't answered, at most once every 3 days per person
delete
/commute-surveys/{surveyId}/recipients/{recipientId}
Remove a person. Their link stops working (410); an answer they gave stays
get
/commute-surveys/{surveyId}/responses
The survey's responses with review state and flags (ordered by response id, not by submit time)
post
/commute-surveys/{surveyId}/responses/review
Accept or reject responses in bulk (open or closed surveys; default workspace only)
post
/commute-surveys/{surveyId}/send
Send the accepted responses to emissions
put
/commute-surveys/{surveyId}/shared-link
Switch "Anyone with the shared link can answer" (draft or open surveys; personal links; default workspace only)
get
/shared/commute-survey
Open a commuting survey by its link token in a header (public)
post
/shared/commute-survey/responses
Submit or update an answer to a commuting survey (public; body at most 1 MiB)
DataFeeds
3
Emissions
6
Factor Manage
19
Factors
1
Partners
8
Period close
6
PlatformOps
10
Reports
34
Sandboxes
5
Sites
17
Supplier portal
15
Suppliers
18
Uploads
17
Workspaces
10
post
/chat/stream
post
/dashboard/layouts
get
/dashboard/layouts/latest
get
/emissions/source-records
List fixed source business fields for Dashboard tables
get
/health
get
/me
get
/me/context
post
/metrics/query/datapoints
get
/metrics/query/filter-options
List organization-wide dynamic metrics filter values
get
/net-zero/action-catalogue
The catalogue entries that apply, with the bases an action can cut
get
/net-zero/action-memos
The workspace's action memos
post
/net-zero/action-memos
Create 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}/actions
Add an action to a year's memo
post
/net-zero/action-memos/{year}/reviews
Record 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}/recalculate
Re-snapshot an action's base and re-estimate it
get
/net-zero/annual-inventories
List observed emissions for completed calendar years
get
/net-zero/baselines
Every confirmed baseline, newest first
post
/net-zero/baselines
Confirm an immutable annual emissions baseline
get
/net-zero/baselines/latest
Read the latest confirmed baseline for one reporting year
get
/net-zero/baselines/{baselineId}/recalculation
Whether a confirmed baseline has drifted from the ledger
get
/net-zero/electricity-instruments
Contractual instruments in force during a calendar year
get
/net-zero/inventory-preview
Preview observed emissions for one reporting year
get
/net-zero/manual-inventories
The 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/profile
The organization profile SBTi CNZS V2.0 categorises by
put
/net-zero/profile
Store the organization profile
get
/net-zero/reference-factors/status
Whether the Scope 2 reference factors are current
get
/net-zero/supplier-engagement
Supplier emissions by SBTi status
get
/net-zero/target-sets
The organization's target sets, newest first
post
/net-zero/target-sets
Save a target set as the active one
get
/net-zero/target-sets/active
Read the active target set, judged against its SBTi rulebook today
post
/net-zero/target-sets/preview
Judge a draft target set without saving it
get
/net-zero/targets/current
Read the organization's current custom target
put
/net-zero/targets/current
Create or update the organization's current custom target
get
/organization/settings
The selected business organization's settings
put
/organization/settings
Store the selected business organization's settings
post
/overview/dashboard/autosaves
Autosave the Overview dashboard the caller is editing, as a private draft
post
/overview/widget-drafts
Draft Overview dashboard widgets from a natural-language request
post
/overview/widget-drafts/{requestId}/cancel
Stop a widget draft request the user no longer wants
get
/pcf/archived-products
List the organization's archived PCF products
delete
/pcf/archived-products/{productId}
Permanently delete an archived PCF product
post
/pcf/archived-products/{productId}/restore
Restore an archived PCF product
post
/pcf/bom-scan
Scan a BOM file for the product it describes
get
/pcf/calculations/{calculationId}
Read one saved calculation snapshot
get
/pcf/conversion-items
List the item vocabulary a BOM line can be described as
get
/pcf/factor-library
Describe the factor library PCF calculations use
post
/pcf/factor-search
Search the PCF factor library for a BOM line
get
/pcf/factors/{factorEntryId}/conversions
List the reviewed conversions from a BOM line's unit to a factor's unit
get
/pcf/products
List the organization's PCF products
post
/pcf/products
Create 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}/bom
Replace a PCF product's bill of materials
get
/pcf/products/{productId}/bom-imports
List a product's BOM file imports
post
/pcf/products/{productId}/bom-imports
Upload 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}/apply
Write an import's lines into the product's BOM
post
/pcf/products/{productId}/bom-imports/{importId}/reanalyze
Read the stored BOM file again
put
/pcf/products/{productId}/bom-imports/{importId}/review
Save the user's review of an import's lines
get
/pcf/products/{productId}/calculations
List a product's saved calculations
post
/pcf/products/{productId}/calculations
Calculate a product's footprint and store it as an immutable snapshot
post
/pcf/products/{productId}/calculations/preview
Calculate a product's footprint from its saved BOM without storing it
get
/pcf/products/{productId}/source-file
Download 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/insights
The latest generated utility insights for a year (cache only)
post
/utility/insights
Generate utility insights for a year
post
/utility/insights/{requestId}/cancel
Stop a utility insights request the user no longer wants
post
/utility/series
Monthly utility cost, energy and carbon by resource
get
/waste/query/emission-factors
post
/waste/query/kpi
get
/waste/query/raw-rows
post
/webhooks/clerk
Commute surveys
Copy Markdown
Copied
Copy failed
Changes to Draft a survey form from a plain-language description (default workspace only)
post
/commute-surveys/drafts
Oct 7, 2026
5c524454c847
Revision changes
○
endpoint added
Ask about this API