Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Credentials

List Credentials

A credential is defined as a set of login requirements needed for Arcadia to access data from utility providers. The credentials endpoint allows you to get a list of all the credentials that are in the Arcadia system. This endpoint is pageable.

This endpoint supports Sandbox Mode.

get/plug/credentials

Query parameters

searchstring

A search query string. See this page for more information.

The searchable fields for this endpoint are:

  • accountIds
  • accountNumbers
  • correlationId
  • createdAt
  • credentialId
  • isAccessible
  • isActive
  • isCustomerActionRequired
  • lastModifiedAt
  • meterIds
  • nextScheduledAccountRunAt
  • normalizedAccountNumbers
  • provider.name
  • provider.providerId
  • siteIds
  • status
  • statusDetail
  • totalAccounts
  • username
  • username2
  • username3
  • username4
globalSearchstring

A global search query string. See this page for more information.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

sortstring[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK