Sample - Plaid API
POST/beacon/report_syndication/listDeprecated

List Beacon Report Syndications for a Beacon User

Lists Beacon Report Syndications associated with a specific Beacon User. Supply beacon_user_id and use cursor to retrieve subsequent pages when next_cursor is present. This operation is deprecated.

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

4 body fields

Request identifying the Beacon User and, optionally, the result page.

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 Report Syndications, a `next_cursor` for any additional page, and a request identifier.
beacon_report_syndicationsarray<BeaconReportSyndication>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 syndications you want to list. Pass the returned next_cursor as cursor to retrieve the next page. Supply valid API credentials through the supported client and secret fields or headers.