List Credentials

get

https://api.arcadia.com/plug/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

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

globalSearch

string

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

page

integer

Defaults to 0

Zero-based page index (0..N)

size

integer

Defaults to 20

The size of the page to be returned

sort

array of strings

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

sort

Headers

Arcadia-Version

string

required

Defaults to 2024-02-21

The Arcadia-Version for the request

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK