PluggyDocs
GET/consents

List

Recovers all consents given to the item provided

Parameters

Query Parameters

NameType
itemIdrequired
string (uuid)

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
{
  "results": [
    {
      "id": "string",
      "itemId": "string",
      "products": [
        "ACCOUNTS"
      ],
      "openFinancePermissionsGranted": [
        "REGISTRATION_ALL"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "expiresAt": "2024-01-01T00:00:00Z",
      "revokedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

Code Examples

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

Try It

Query Parameters