Create an Export

post https://app.referralsaasquatch.com/api/v1//export

Creates an asynchronous request for an Exports. Depending on the size of the Export and other exports in the export pipeline, it may take awhile for an export request to complete. Once the Export is completed, it can be downloaded in the requested format (CSV or zipped XLSX) using the download URL endpoint.

Here are a few ways to check for when an export is ready:

  • Polling — While an export is being prepared you can check the status using the id. Make sure you store the id of the export when you request it.
  • Webhooks — When an export is complete, a webhook event will be fired. Make sure you create a webhook endpoint subscription before you create your export.
  • Listing — You can use the API to list recent exports, and check their status.
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!