GET/consents

List

Recovers all consents given to the item provided

Parameters

Query Parameters

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

Responses

200Retrieve a list of all consents given to an item

object

resultsrequiredobject[]

itemsobject

Item consent information

pagerequirednumber (double)

totalrequirednumber (double)

totalPagesrequirednumber (double)

Example response

json

{
  "total": 1,
  "totalPages": 1,
  "page": 1,
  "results": [
    {
      "id": "71996b6d-8991-450c-8542-ae59069d1a9d",
      "itemId": "9aab8d24-c89b-4b0e-8974-7dd5614686e4",
      "products": [
        "ACCOUNTS",
        "IDENTITY"
      ],
      "openFinancePermissionsGranted": [
        "ACCOUNTS_ALL",
        "REGISTRATION_ALL"
      ],
      "createdAt": "2023-10-02T03:00:00.000Z",
      "expiresAt": "2024-10-02T03:00:00.000Z",
      "revokedAt": null
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/consents' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Sample response

{
  "total": 1,
  "totalPages": 1,
  "page": 1,
  "results": [
    {
      "id": "71996b6d-8991-450c-8542-ae59069d1a9d",
      "itemId": "9aab8d24-c89b-4b0e-8974-7dd5614686e4",
      "products": [
        "ACCOUNTS",
        "IDENTITY"
      ],
      "openFinancePermissionsGranted": [
        "ACCOUNTS_ALL",
        "REGISTRATION_ALL"
      ],
      "createdAt": "2023-10-02T03:00:00.000Z",
      "expiresAt": "2024-10-02T03:00:00.000Z",
      "revokedAt": null
    }
  ]
}