Sample - Plaid API
POST/beacon/user/history/listDeprecated

List Beacon User history

Lists all recorded changes to a Beacon User in reverse-chronological order. Provide beacon_user_id to identify the user's revision history and use cursor to request a subsequent page. The response includes the returned Beacon User versions and a cursor for continuing pagination.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 body fields

Request input for listing a Beacon User's revision history.

beacon_user_idstringrequired
ID of the associated Beacon User.
cursorstringoptional
An identifier that determines which page of results you receive.
client_idstringoptional
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.
secretstringoptional
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.

1 status code
200Returns an array of Beacon User revisions in reverse-chronological order, a `next_cursor` for pagination, and a request identifier.
beacon_usersarray<BeaconUser>required
next_cursorstringrequired
An identifier that determines which page of results you receive.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

beacon_user_id is required and must identify the Beacon User whose history you want to list. Pass the returned next_cursor as cursor to retrieve the next page when more history is available.