EnergyCAP Developer
Documentation API Reference
Guides
Getting Started
Getting Started Environments API Authentication Paging Filters Field Reduction API Versioning Webhooks
SDKs
Overview C# SDK Python SDK (Beta) Angular/TypeScript SDK (Beta) PowerShell
SSO
Overview Microsoft Entra ID Okta
Reference
API Reference
Account AccountDigest AccountMeter Accrual Activity Admin Api ApiKey Audit Authentication Batch Bill BillAccountChargeSplit BillImportRule BillSplit BillView Budget CalculatedBill Channel ChargebackEngine ChargebackTask ChargebackWorkflow Collection Commodity CommodityCategory CommodityDigest CostCategory CostCenter CostCenterDigest Country Customer Dashboard DataPoint EmissionRecord EmissionSource EnergyProject EnergyStar Environment EsaChannel EsaPlace EsaReading EsaReadingNote EUIGoal Export FileStore Filter Flag Formula GeneralLedger GHG Hierarchy Import List Me Meter MeterDigest MeterGroup MeterGroupDigest Notification Observation ObservationType Place PlaceBenchmark PlaceDigest PlaceGroup PlaceGroupDigest PostalCode PrimaryUse Rate RateDigest Report ReportBuilder ReportDistribution Route Savings Schedule Search Sentinel Setup SummaryAccount SystemUser Tag Task Template TimeZone UDF Unit UserGroup UserRole UtilityPlatform Vendor VendorDigest Watts WeatherStation WebCaptureCredential WebCapturePartner Webhook Widget Workflow
API Reference / UDF

UDF

GET 2 endpoints
/api/v3/udf GetUDFsV3
Retrieves all user defined field definitions, optionally filtered by UDF type
/api/v3/udf/{udfId} GetUDFV3
Retrieves a single user defined field definition by ID
POST 1 endpoint
/api/v3/udf CreateUDFV3
Creates a new user defined field definition
PUT 2 endpoints
/api/v3/udf/list/{udfType} EditCustomFieldsV3
Replaces all UDF definitions for a given entity type with the provided list
/api/v3/udf/{udfId} EditUDFV3
Edits an existing user defined field definition
DELETE 1 endpoint
/api/v3/udf/{udfId} DeleteUDFV3
Deletes a user defined field definition and all associated values