Export user data using the API

Export the user data available on the Dashboard as a .csv file, programmatically.

Guide

1. Call the exportUserData 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 narrow the export: user status, nationality, identification level, preferred notification channel, mobile phone number, birthdate, or a search string.
4. Add the success payload and rejections.

Mutation

Open in API Explorer

mutation ExportUsers {
  exportUserData(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": {
    "exportUserData": {
      "__typename": "ExportDataSuccessPayload",
      "exportId": "$EXPORT_ID"
    }
  }
}

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