Audience:
Developers
Export account holder data using the API
Export the account holder data available on your Dashboard programmatically with the API.
Guide
- Call the
exportAccountHolderDatamutation. - Add your
email. A link to download the.csvexport is sent to the email address you provide. - Add the success payload and rejections.
Mutation
Open in API Explorermutation 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.
Also available
Export account holder dataFrom the Dashboard