v1
latestOpenAPI 3.1.02026-07-1342111193.6 KBUtility Accounts
List Utility Accounts
Returns a paginated list of UtilityAccounts for all users, or filtered by client_user_id. Default ordered by descending updated_at.
get/utility_accounts
Query parameters
client_user_idstring
A client_user_id to filter the list of returned items by.
limitinteger
updated_afterstring date-time
ISO8601 datetime, used to traverse paginated responses. Use of this parameter is mutually exclusive with updated_before.
updated_beforestring date-time
ISO8601 datetime, used to traverse paginated responses. Use of this parameter is mutually exclusive with updated_after.
order'asc' | 'desc'
Used to specify the order in which records should be returned. Currently ordered by updated_at timestamp.
Headers
Arcadia-Versionstring required
The Arcadia-Version for the request
Response
Success
Example response
{
"data": [
{
"id": 12345,
"client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
"utility_name": "AEP SWEPCO",
"utility_long_name": "AEP SWEPCO AR",
"utility_credential_id": 54321,
"account_number": "7626177069",
"service_address_street_one": "1060 W Addison",
"service_address_street_two": "Apartment 1",
"service_address_city": "Chicago",
"service_address_state": "IL",
"service_address_zip": "60613",
"service_customer_name": "Joan Arcadia",
"supplier_account_id": "123456789",
"most_recent_tariff": {
"main_tariff_id": "gen_mtid_3331108",
"property_inputs": [
{
"id": "territoryId"
}
],
"supplier_name": "East Bay Community Energy",
"tariff_code": "EV-2A-TOU",
"tariff_name": "Residential - Time of Use - Plug-In Electric Vehicle 2",
"utility_name": "Pacific Gas & Electric",
"tariff_as_of_date": "2021-03-01"
},
"utility_meters": [
{
"id": 12345,
"client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
"utility_credential_id": 54321,
"utility_account_id": 65432,
"meter_number": "12300000045 67"
}
]
}
],
"total_count": 1
}