Sign in
plaid

List Items associated with a User

Returns Items associated with a User along with their corresponding statuses.

post/user/items/list

Request body

client_idstring

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.

secretstring

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.

user_idstring required

A unique user_id generated by Plaid for the client-provided client_user_id. This field is currently in beta.

cursorstring

An identifier that can be used to retrieve the next set of Items. The /user/items/list response will contain a next_cursor field if the user has additional Items that were not returned.

limitinteger

The maximum number of Items to return in the response. If not specified, defaults to 100.

Response

OK

request_idstring required

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

next_cursorstring nullable required

An identifier to pass in /user/items/list as the optional cursor parameter for the next page of Item results. If this is null then there are no more Items for the given user.

Example response

{
  "next_cursor": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

Changes