Admin
GET
7 endpoints
/api/v3/admin/accounting
GetAccountingSettingsV3
Get accounting settings including fiscal year configuration, calendarization method, and account period definitions.
/api/v3/admin/accountperiod
GetAccountPeriodsV3
Get the list of account periods (12 named periods per fiscal year).
/api/v3/admin/license
GetLicenseDetailsV3
Get license details including validation key, expiration, meter/account limits, usage counts, and feature flags.
/api/v3/admin/logo
GetOrganizationLogoV3
Retrieve the organization logo, if configured. Only URLs or JPEG, PNG, and SVG images are acceptable organization logos. If the saved base64 image is of a different file type, it will return an error.
/api/v202305/admin/reportingSettings
GetReportingSettingsV202305
Get the system reporting settings including energy unit and cost reporting unit configuration.
/api/v3/admin/systemSettings
GetSystemSettingsNewV3
Get structured system settings including organization name, defaults, time zone, and configuration values.
/api/v3/admin/systemsetting
GetSystemSettingsV3
Get raw system settings as key-value pairs. Returns field names, values, and data types for all owner-level settings.
PUT
8 endpoints
/api/v3/admin/accounting
EditAccountingSettingsV3
Edit accounting settings including fiscal year start month, calendarization method, and all 12 account period definitions.
/api/v3/admin/license
EditLicenseDetailsV3
Update the license validation key. Validates the new key before saving.
/api/v3/admin/systemSettings
Deprecated
EditSystemSettingsNewV3
Edit structured system settings including organization name, defaults, and configuration.
/api/v202306/admin/systemSettings
Deprecated
EditSystemSettingsV202306
Edit structured system settings with V202306 request body (adds default topmost collection ID).
/api/v202405/admin/systemSettings
EditSystemSettingsV202405
Edit structured system settings with V202405 request body (adds default topmost space ID).
/api/v3/admin/customapplicationaction/{webhookId}
ProcessCustomAppActionV3
Fire a custom application action webhook and return the execution log.
/api/v202305/admin/reportingSettings
SetReportingSettingsV202305
Update the system reporting settings. If the cost reporting unit changes, a background task is created to update all cost data.
/api/v3/admin/systemsetting
UpdateSystemSettingsV3
Update one or more raw system settings by field name. If a calendarization/normalization setting changes,
all bills are automatically re-calendarized.