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 / UserRole

UserRole

GET 2 endpoints
/api/v3/userrole GetUserRolesV3
Retrieves all user roles with their permission sets
/api/v3/userrole/{userRoleId} GetUserRoleV3
Retrieves a single user role by its unique identifier
POST 2 endpoints
/api/v202206/userrole CreateUserRoleV202206
Creates a new user role with optional hidden flag
/api/v3/userrole Deprecated CreateUserRoleV3
Creates a new user role with a permission set
PUT 3 endpoints
/api/v202206/userrole/{userRoleId} EditUserRoleV202206
Updates an existing user role with optional hidden flag
/api/v3/userrole/{userRoleId} Deprecated EditUserRoleV3
Updates an existing user role's name and permission set
/api/v202206/userrole/{userRoleId}/hidden SetUserRoleHiddenV202206
Sets the hidden/visible status of a user role
DELETE 1 endpoint
/api/v3/userrole/{userRoleId} DeleteUserRoleV3
Deletes a user role by its identifier