Sign in

v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB
Utility Credentials

List Utility Credentials

Returns a paginated list of UtilityCredentials for all users, or filtered by client_user_id. Default ordered by descending updated_at.

get/utility_credentials

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

total_countinteger required

Example response

{
  "data": [
    {
      "id": 12345,
      "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
      "utility_name": "AEP SWEPCO",
      "utility_long_name": "AEP SWEPCO AR",
      "username": "great_customer"
    }
  ],
  "total_count": 1
}