GET/v1/definitions/{key}/rows/{rowId}/plaid/items

A deal's linked banks

Every bank connected to this deal, with the accounts inside each one, its institution, whether it still works, and who consented to the link and when. Never the access token - there is no field for it. Reach for this before offering to link a bank, and to explain where a statement month with source 'plaid' came from.

Access class: def:read.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

rowIdpath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

:rowIdstringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "accounts": [
        "string"
      ],
      "consentedAt": "string",
      "consentedByEmail": "string",
      "consentedByKind": "string",
      "consentedByUserId": 1,
      "consentedIp": "string",
      "createdAt": "string",
      "dealId": "",
      "environment": "string",
      "id": "",
      "institutionId": "",
      "institutionName": "string",
      "lastError": "string",
      "lastSyncedAt": "string",
      "plaidItemId": "",
      "status": "string"
    }
  ]
}

dataarray<>optional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired