GET/items/{id}/resources

List Item resources

Open Finance only. Lists the resources the financial institution declared for this item's consent, exactly as the institution reported them. Use it to answer what a consent actually covers, and what the institution says about each part of it. A resource reported as `PENDING_AUTHORISATION` or `UNAVAILABLE` explains an absent product, and is something the end user can act on at their bank. Whether Pluggy holds the matching record is a separate question: use the product endpoints (`/accounts`, `/investments`, `/loans`) and the Item's `statusDetail` for that. The list is a snapshot from the last execution that reached the institution, so it can be older than the item itself. The Item's `resourcesCollectedAt` says when it was taken — and an empty list means the institution shared nothing only when that field is set; when it is `null`, the list was never obtained. Items on non Open Finance connectors return an empty page rather than an error.

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Item primary identifier

Query Parameters

Name	Type	Description
`pageSize`	number (double)	Page size for the paging request, default: 500
`page`	number (double)	Page number for the paging request, default: 1
`status`	string	Only resources with this status, spelled as Open Finance reports it. `PENDING_AUTHORISATION` lists what is still awaiting authorization at the institution. `AVAILABLEUNAVAILABLETEMPORARILY_UNAVAILABLEPENDING_AUTHORISATION`

Responses

200The resources declared for the item's consent

object

pagenumber (double)

totalnumber (double)

totalPagesnumber (double)

resultsobject[]

List of declared resources

itemsobject

One resource the financial institution declared for the item's Open Finance consent, reported verbatim.

Example response

json

{
  "page": 1,
  "total": 3,
  "totalPages": 1,
  "results": [
    {
      "resourceId": "1f9a5e0c-3d2b-4a1e-9c7f-2b8d6e4a1c30",
      "type": "ACCOUNT",
      "status": "AVAILABLE"
    },
    {
      "resourceId": "6c2d8b41-7e5a-4f03-b19d-8a4e2c7f5b60",
      "type": "CREDIT_CARD_ACCOUNT",
      "status": "PENDING_AUTHORISATION"
    },
    {
      "resourceId": "a3e71d92-5b48-4c6f-8e20-1d9c3b7a4e50",
      "type": "FUND",
      "status": "UNAVAILABLE"
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/items/{id}/resources' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Sample response

{
  "page": 1,
  "total": 3,
  "totalPages": 1,
  "results": [
    {
      "resourceId": "1f9a5e0c-3d2b-4a1e-9c7f-2b8d6e4a1c30",
      "type": "ACCOUNT",
      "status": "AVAILABLE"
    },
    {
      "resourceId": "6c2d8b41-7e5a-4f03-b19d-8a4e2c7f5b60",
      "type": "CREDIT_CARD_ACCOUNT",
      "status": "PENDING_AUTHORISATION"
    },
    {
      "resourceId": "a3e71d92-5b48-4c6f-8e20-1d9c3b7a4e50",
      "type": "FUND",
      "status": "UNAVAILABLE"
    }
  ]
}