Export onboarding data using the API

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

Guide

1. Call the exportOnboardingData 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.
   • The following mutation is filtered to Invalid Company onboardings (line 5).
4. Add the success payload and rejections.

Mutation

Open in API Explorer

mutation ExportOnboardings {
  exportOnboardingData(
    input: {
      email: "$YOUR_EMAIL_ADDRESS"
      filters: { types: Company, status: Invalid }
    }
  ) {
    ... on ExportDataSuccessPayload {
      __typename
      exportId
    }
    ... on MaximumSimultaneousExportsRejection {
      __typename
      message
    }
    ... on MaximumDailyExportsReachedRejection {
      __typename
      message
    }
  }
}

Payload

The payload returns the export ID.

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

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