Retrieves a paginated list of Deck WebCAPture accounts that are not currently receiving bills, with optional filtering.
Use this endpoint to populate the “Enable Accounts” experience, which lists Deck accounts that are eligible to be
enrolled for bill retrieval but are not yet enabled (isExternalAccountEnabled is false). Results are limited to the
Deck partner and to the authenticated user’s owner. Supports server-side pagination and filtering; use the filter
parameter to look up specific accounts (e.g. by account number, vendor name, or the username of a linked credential).
To enable/disable bill retrieval for accounts returned here, use POST /api/v202606/webCaptureAccount/updateEnabled.
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| filter | Optional filter supporting equality and contains operators on account number, vendor name, and the username of a linked credential. | string (string) | Optional |
| orderBy | Optional ordering by account number or vendor name (ascending or descending). | string (string) | Optional |
| pageSize | The number of elements to return in a page | integer (int32) | Optional |
| pageNumber | The current page number | integer (int32) | Optional |
Filters
| Filter | Description | Type | Operators |
|---|---|---|---|
| accountNumber | Account Number | String | equals not equals one of like not like not one of |
| username | Username | String | equals not equals one of like not like not one of |
| vendorName | Vendor Name | String | equals not equals one of like not like not one of |
Order By Options
| Name | Description |
|---|---|
| accountNumber | Account Number |
| vendorName | Vendor Name |
Response Headers
This endpoint returns pagination metadata in the response headers.
| Header | Type | Description |
|---|---|---|
| PageNumber | integer | The current page number (1-based). |
| PageSize | integer | The maximum number of items per page. |
| TotalNumberOfRecords | integer | The total number of records matching the query across all pages. |
| TotalPages | integer | The total number of pages. Increment pageNumber until it equals this value to retrieve all results. |
See the Pagination guide for iteration examples and best practices.
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
WebCaptureAccountListItemResponseV202606
| Property | Description | Type |
|---|---|---|
| accountNumber | The utility account number as provided by the vendor portal. | string |
| username | The username of a credential linked to this account. An account can be linked to more than one credential (and therefore more than one username); the first (alphabetical) is returned. Null when the account has no linked credential. | string |
| vendorName | The name of the vendor (utility provider) the account belongs to. | string |
| webCaptureAccountId | The unique numeric identifier of the WebCAPture account. Pass this value to POST /api/v202606/webCaptureAccount/updateEnabled to enable bill retrieval for the account. | integer (int32) |
Example Response
[
{ "accountNumber": "string", "username": "string", "vendorName": "string", "webCaptureAccountId": 1
}
]