GET/items/{id}/resources

Retrieve Item resources

Open Finance only. Lists every resource the financial institution declared for the consent, with the availability it reported, cross-checked against the data Pluggy actually holds for the item. Use it to tell apart the two situations behind "a product has no data": the institution reported the resource as unavailable or pending authorisation (expected, and something the end user can act on), versus the institution reported it as available but nothing came through (a collection problem). The declared side is a snapshot taken during the last execution that reached the institution, so it can be older than the item itself — `collectedAt` says when it was taken. The retrieved side is read live on every request.

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200The item resource inventory
object
itemIdstring (uuid)

Item the inventory belongs to

connectorIdnumber

Connector of the item

isOpenFinanceboolean

Whether the item belongs to an Open Finance connector. `false` returns an empty inventory: only Open Finance institutions report a resources list.

declaredListAvailableboolean

Whether the institution's resources list was obtained on the last execution. When `false`, the rows below are built only from the data Pluggy holds and every one of them is `UNDECLARED`. Note this is different from the institution answering with an empty list, which returns `true` with no resources.

collectedAtstring (date-time) | null

When the institution's list was read. `null` when it was not obtained.

itemLastUpdatedAtstring (date-time) | null

Last time the item finished updating, for comparison against `collectedAt`

itemExecutionStatusstring

Execution status of the item's last update

resourcesobject[]

One entry per declared resource, plus one per record held that the institution never declared. Anomalies are listed first.

itemsobject
summaryobject
totalnumber

Number of rows in `resources`

oknumber
missingnumber
blockednumber
unexpectednumber
undeclarednumber
curl -X GET \
'https://api.pluggy.ai/items/{id}/resources' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY'
Sample response
null