Skip to main content

Audience:

Developers

Export account holder data using the API

Export the account holder data available on your Dashboard programmatically with the API.

Guide

  1. Call the exportAccountHolderData mutation.
  2. Add your email. A link to download the .csv export is sent to the email address you provide.
  3. Add the success payload and rejections.

Mutation

Open in API Explorer
mutation ExportAccountHolders {
exportAccountHolderData(input: { email: "$YOUR_EMAIL_ADDRESS" }) {
... on ExportDataSuccessPayload {
__typename
exportId
}
... on MaximumSimultaneousExportsRejection {
__typename
message
}
... on MaximumDailyExportsReachedRejection {
__typename
message
}
}
}

Payload

The payload returns the export ID.

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

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