Skip to main content
GET
Get Plaid items

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

200 - application/json

Successful operation

status
enum<string>
required

Status of this Plaid Item

Available options:
ACTIVE,
DELETED
Example:

"ACTIVE"

createdDate
string<date-time>
required

Date Plaid Item got created

apiItemId
string
required

Id of the Plaid Item, for reference within Plaid's API

Example:

"3E51DvPAgMigGmybkpv9tzNjbjboEotqykvEo"

apiInstitutionId
string
required

Id of the institution that the transaction originated from

Example:

"ins_4"

apiInstitutionName
string
required

Name of the institution that the transaction originated from

Example:

"Citi"

apiAccessToken
string
required

Access Token of the Plaid Item, for reference within Plaid's API

Example:

"access-sandbox-da40d92a-dbc7-4399-be1c-fdb63338a147"

id
integer<int64>

Id of the Plaid Item, required when updating existing Plaid Item

isInitialReady
boolean
read-only

Whether the INITIAL Plaid Item webhook has been sent by Plaid, indicating that recent transactions are available

Example:

true

isHistoricalReady
boolean
read-only

Whether the HISTORICAL Plaid Item webhook has been sent by Plaid, indicating that historical transactions are available

Example:

true

apiErrorType
string

error_type of the Plaid error

Example:

"ITEM_ERROR,API_ERROR"

apiErrorCode
string

error_code of the Plaid error

Example:

"ITEM_LOGIN_REQUIRED"

apiErrorDisplayMessage
string

display_message of the Plaid error

apiErrorMessage
string

error_message of the Plaid error

Example:

"the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state"

Flag to indicate additional user consent is required to access all features available on this integration. Commonly used to indicate there are more available products on a Plaid Item.

lastInstitutionTranDate
string<date-time>

Date of most recent transaction under the same institution as this Plaid item