Export account data using the API

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

Guide

1. Call the exportAccountData mutation.
2. Add your email. A link to download the .csv export is sent to the email address you provide.
3. Optionally, add filters to limit the export; the example exports only accounts with the payment level Limited and the status Opened.
4. Add the success payload and rejections.

Mutation

Open in API Explorer

mutation ExportAccount {
  exportAccountData(
    input: { email: "$YOUR_EMAIL_ADDRESS", filters: { paymentLevels: Limited, status: Opened } }
  ) {
    ... on ExportDataSuccessPayload {
      __typename
      exportId
    }
    ... on MaximumSimultaneousExportsRejection {
      __typename
      message
    }
    ... on MaximumDailyExportsReachedRejection {
      __typename
      message
    }
  }
}

Payload

The payload returns the export ID.

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

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