plaid

Retrieve a Dashboard user

The /dashboard_user/get endpoint provides details (such as email address) about a specific Dashboard user based on the dashboard_user_id field, which is returned in the audit_trail object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.

post/dashboard_user/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/dashboard_user/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

dashboard_user_idstring required

ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use /dashboard_user/get.

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.

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.

Example request

{
  "dashboard_user_id": "54350110fedcbaf01234ffee"
}

Response

OK

idstring required

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_atstring date-time required

An ISO8601 formatted timestamp.

email_addressstring email required

A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696.

status'invited' | 'active' | 'deactivated' required

The current status of the user.

request_idstring required

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

Example response

{
  "id": "54350110fedcbaf01234ffee",
  "created_at": "2020-07-24T03:26:02Z",
  "email_address": "user@example.com",
  "status": "active"
}

Changes

No recorded changes to this operation across all 55 revisions of this API.