Export account membership data using the API

Export account membership data with the API to review member roles and permissions for each account programmatically.

Guide

1. Call the exportAccountMembershipData mutation.
2. Add your email. A link to download the .csv export is sent to the email address you provide.
3. If required, add filters to your export (lines 5-11).
4. Add the success payload and rejections.

Mutation

Open in API Explorer

mutation ExportAccountMemberships {
  exportAccountMembershipData(
    input: {
      email: "$YOUR_EMAIL_ADDRESS"
      filters: {
        status: Enabled
        canInitiatePayments: true
        canManageAccountMembership: false
        canManageBeneficiaries: false
        canManageCards: true
        canViewAccount: true
      }
    }
  ) {
    ... on ExportDataSuccessPayload {
      __typename
      exportId
    }
    ... on MaximumSimultaneousExportsRejection {
      __typename
      message
    }
    ... on MaximumDailyExportsReachedRejection {
      __typename
      message
    }
  }
}

Payload

The payload returns the export ID.

{
  "data": {
    "exportAccountMembershipData": {
      "__typename": "ExportDataSuccessPayload",
      "exportId": "$EXPORT_ID"
    }
  }
}

After finalizing your export, a download link is sent to the email address you provided.