Skip to main content
POST
/
item
/
get
/item/get
curl --request POST \
  --url http://localhost:8080/plaid-compatible/item/get \
  --header 'Content-Type: application/json' \
  --header 'PLAID-CLIENT-ID: <api-key>' \
  --data '{
  "client_id": "<string>",
  "secret": "<string>",
  "access_token": "<string>"
}'
{
  "item": {
    "item_id": "<string>",
    "institution_id": "<string>",
    "webhook": "<string>",
    "error": {
      "error_type": "INVALID_REQUEST",
      "error_code": "<string>",
      "error_message": "<string>",
      "display_message": "<string>",
      "request_id": "<string>",
      "causes": [
        {}
      ],
      "status": 123,
      "documentation_url": "<string>",
      "suggested_action": "<string>"
    },
    "available_products": [
      "transactions"
    ],
    "billed_products": [
      "transactions"
    ],
    "products": [
      "transactions"
    ],
    "consented_products": [
      "transactions"
    ]
  },
  "status": {
    "investments": {
      "last_successful_update": "2023-11-07T05:31:56Z",
      "last_failed_update": "2023-11-07T05:31:56Z"
    },
    "transactions": {
      "last_successful_update": "2023-11-07T05:31:56Z",
      "last_failed_update": "2023-11-07T05:31:56Z"
    },
    "last_webhook": {
      "sent_at": "2023-11-07T05:31:56Z",
      "code_sent": "<string>"
    }
  },
  "request_id": "<string>"
}

Authorizations

​
PLAID-CLIENT-ID
string
header
required

Headers

​
Plaid-Version
string | null

Body

application/json

ItemGetRequest defines the request schema for /item/get

​
access_token
string
required

The access token associated with the Item data is being requested for.

​
client_id
string | null

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

​
secret
string | null

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Response

OK

ItemGetResponse defines the response schema for /item/get and /item/webhook/update

​
item
object
required

Metadata about the Item.

​
request_id
string
required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

​
status
object | null

Information about the last successful and failed transactions update for the Item.