Sample - Plaid API
POST/dashboard_user/get

Retrieve a Dashboard user

Retrieves details for a specific Dashboard user, including the user's email address and account status. Use dashboard_user_id from an audit_trail object to identify the reviewer associated with a Dashboard action. The response includes creation metadata and a request identifier.

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

3 body fields

Request identifying the Dashboard user whose account details you want to retrieve.

dashboard_user_idstringrequired
ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use `/dashboard_user/get`.
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.
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.

1 status code
200Returns the Dashboard user's ID, creation timestamp, RFC-compliant email address, status, and a unique `request_id`.
idstringrequired
ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use `/dashboard_user/get`.
created_atstringrequired
An ISO8601 formatted timestamp.
email_addressstringrequired
A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see [RFC 3696](https://datatracker.ietf.org/doc/html/rfc3696).
statusstringrequired
The current status of the user.
Allowed:invitedactivedeactivated
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

dashboard_user_id is required and must identify the Dashboard user whose details you want to retrieve. client_id and secret may be supplied in the request body or their corresponding headers.