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 BillSplit BillView Budget CalculatedBill Channel ChargebackEngine ChargebackTask ChargebackWorkflow Collection Commodity CommodityCategory CommodityDigest CostCategory CostCenter CostCenterDigest Country Customer Dashboard DataPoint EmissionRecord EmissionSource EnergyManager EnergyProject EnergyStar Environment EsaChannel EsaPlace EsaReading 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 WeatherStation Webhook Widget Workflow
API Reference / UserRole

UserRole

GET 2 endpoints
/api/v3/userrole GetUserRolesV3
Gets user roles and their permissions You need Roles.Manage or UsersAndUserGroups.View for this API
/api/v3/userrole/{userRoleId} GetUserRoleV3
Gets a specific user role and its permissions You need Roles.Manage or UsersAndUserGroups.View for this API
POST 2 endpoints
/api/v202206/userrole CreateUserRoleV202206
/api/v3/userrole Deprecated CreateUserRoleV3
Creates a new user role
PUT 3 endpoints
/api/v202206/userrole/{userRoleId} EditUserRoleV202206
/api/v3/userrole/{userRoleId} Deprecated EditUserRoleV3
Edit a user role
/api/v202206/userrole/{userRoleId}/hidden SetUserRoleHiddenV202206
DELETE 1 endpoint
/api/v3/userrole/{userRoleId} DeleteUserRoleV3
Deletes a user role