Export

Endpoints for working with bulk data exports: create a new export, look up the status of an existing export, download a completed export, and list recent exports.

List Exports

get

Returns a paginated list of exports in the tenant. Useful for finding a recent export when you don't have its id.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Query parameters

limitintegerOptional

A limit on the maximum number of results to return, defaults to 10.

Default: 10

offsetintegerOptional

The row number of the first result to return, defaults to 0.

Default: 0

Responses

200

List of Exports found

application/json

A paginated list of Export objects.

countintegerOptional

The number of results in this page. See totalCount for the total available.

Example: 2

totalCountintegerOptional

The total number of results available across all pages.

Example: 2

default

Unexpected Error

application/json

get/{tenant_alias}/export/history/list

GET /api/v1/{tenant_alias}/export/history/list HTTP/1.1
Host: app.referralsaasquatch.com
Authorization: Basic username:password
Accept: */*

{
  "data": [
    {
      "type": "USER",
      "format": "CSV",
      "name": "Monthly user export",
      "requester": "API",
      "params": {
        "createdSince": 1,
        "createdBefore": 1,
        "updatedSince": 1,
        "updatedBefore": 1,
        "createdOrUpdatedSince": 1,
        "createdOrUpdatedBefore": 1,
        "programId": "text",
        "filter": {},
        "at": 1,
        "fields": {
          "includeUserStatsFields": false,
          "includeUserFields": false,
          "includeReferralFields": false
        }
      }
    },
    {
      "id": "abc123export",
      "mailtoEmail": "bob.testerson@example.com",
      "status": "COMPLETED",
      "dateCreated": 1779871222634,
      "dateCompleted": 1779871250427,
      "dateExpires": 1782290450427
    }
  ],
  "count": 2,
  "totalCount": 2
}

Create an Export

post

Creates an asynchronous export request. The export is queued and processed in the background; the response returns the export's id and an initial status of PENDING.

Store the returned id so you can look up the export's status or download it once complete. For details on the export lifecycle and how to detect completion, see the Export Overview.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

Body

Request body for creating a new export.

typestring · enumRequired

The type of Export that's being requested.

Example: USERPossible values:

formatstring · enumOptional

The format of the Export

Default: CSVExample: CSVPossible values:

namestringOptional

A user-friendly name for this report. Useful for keeping track of which report is which.

Example: Monthly user export

requesterstringOptional

Detail on the service or user that requested this report. Defaults to "API" when not provided.

Default: APIExample: API

Responses

201

Export created

application/json

An export record. Includes the original request fields plus the export's id, status, and timestamps.

and

default

Unexpected Error

application/json

post/{tenant_alias}/export

POST /api/v1/{tenant_alias}/export HTTP/1.1
Host: app.referralsaasquatch.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 347

{
  "type": "USER",
  "format": "CSV",
  "name": "Monthly user export",
  "requester": "API",
  "params": {
    "createdSince": 1,
    "createdBefore": 1,
    "updatedSince": 1,
    "updatedBefore": 1,
    "createdOrUpdatedSince": 1,
    "createdOrUpdatedBefore": 1,
    "programId": "text",
    "filter": {},
    "at": 1,
    "fields": {
      "includeUserStatsFields": false,
      "includeUserFields": false,
      "includeReferralFields": false
    }
  }
}

{
  "type": "USER",
  "format": "CSV",
  "name": "Monthly user export",
  "requester": "API",
  "params": {
    "createdSince": 1,
    "createdBefore": 1,
    "updatedSince": 1,
    "updatedBefore": 1,
    "createdOrUpdatedSince": 1,
    "createdOrUpdatedBefore": 1,
    "programId": "text",
    "filter": {},
    "at": 1,
    "fields": {
      "includeUserStatsFields": false,
      "includeUserFields": false,
      "includeReferralFields": false
    }
  },
  "id": "abc123export",
  "mailtoEmail": "bob.testerson@example.com",
  "status": "COMPLETED",
  "dateCreated": 1779871222634,
  "dateCompleted": 1779871250427,
  "dateExpires": 1782290450427
}

Lookup an Export

get

Returns the current state of an export, including its status. Use this to poll for completion before attempting to download.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

exportIdstringRequired

The id of the export to look up.

Responses

200

Export found

application/json

An export record. Includes the original request fields plus the export's id, status, and timestamps.

and

404

Export NOT found

default

Unexpected Error

application/json

get/{tenant_alias}/export/{exportId}

GET /api/v1/{tenant_alias}/export/{exportId} HTTP/1.1
Host: app.referralsaasquatch.com
Authorization: Basic username:password
Accept: */*

{
  "type": "USER",
  "format": "CSV",
  "name": "Monthly user export",
  "requester": "API",
  "params": {
    "createdSince": 1,
    "createdBefore": 1,
    "updatedSince": 1,
    "updatedBefore": 1,
    "createdOrUpdatedSince": 1,
    "createdOrUpdatedBefore": 1,
    "programId": "text",
    "filter": {},
    "at": 1,
    "fields": {
      "includeUserStatsFields": false,
      "includeUserFields": false,
      "includeReferralFields": false
    }
  },
  "id": "abc123export",
  "mailtoEmail": "bob.testerson@example.com",
  "status": "COMPLETED",
  "dateCreated": 1779871222634,
  "dateCompleted": 1779871250427,
  "dateExpires": 1782290450427
}

Download an Export

get

Downloads a completed export file. The export's status must be COMPLETED; use the lookup endpoint to confirm before calling this.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key. Use this method of security only in server-to-server interactions.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

exportIdstringRequired

The id of the export to download.

Responses

200

Export file returned after following the redirect.

text/csv

string · binaryOptional

303

Redirect to the export file. Follow the Location header to download the CSV from the storage provider. Ensure your HTTP client is configured to follow redirects (e.g. curl -L).

default

Unexpected Error

application/json

get/{tenant_alias}/export/{exportId}/download

GET /api/v1/{tenant_alias}/export/{exportId}/download HTTP/1.1
Host: app.referralsaasquatch.com
Authorization: Basic username:password
Accept: */*

binary

PreviousExport Overview NextModels

Last updated 1 month ago