plaid

List Dashboard users

The /dashboard_user/list endpoint provides details (such as email address) about all Dashboard users associated with your account. This can be used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.

post/dashboard_user/list

Request

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

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.

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.

cursorstring nullable

An identifier that determines which page of results you receive.

Example request

{
  "cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Response

OK

next_cursorstring nullable required

An identifier that determines which page of results you receive.

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

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

Changes

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