# Referral SaaSquatch (v2) Information note **Referral SaaSquatch is supported by the Singer community** This integration is powered by [Singer's](https://www.singer.io/) Referral SaaSquatch tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-referral-saasquatch) or [join the Singer Slack](https://singer-slackin.herokuapp.com/). ## Referral SaaSquatch integration summary Stitch’s Referral SaaSquatch integration replicates data using the [Referral SaaSquatch REST API](https://docs.referralsaasquatch.com/api/). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#schema) section for a list of objects available for replication. ## Referral SaaSquatch feature snapshot A high-level look at Stitch's Referral SaaSquatch (v2) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on Feb 26, 2026 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-referral-saasquatch](https://github.com/singer-io/tap-referral-saasquatch) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | ## Connecting Referral SaaSquatch ### Step 1: Retrieve your Referral SaaSquatch API credentials 1. Sign into your Referral SaaSquatch account. 2. In the **Setup** section of the left nav tab, click the **Install** option. 3. In this page, locate the **Tenant Alias** and **API Key** fields. 4. In the **API Key** field, click the **Click to Reveal** link to reveal your API Key. Leave this page open for now - you’ll need it to complete the setup in Stitch. ### Step 2: Add Referral SaaSquatch as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **Referral SaaSquatch** icon. 4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination. For example, the name “Stitch Referral SaaSquatch” would create a schema called `stitch_referral_saasquatch` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. In the **Tenant Alias** field, paste your Referral SaaSquatch Tenant Alias. 6. In the **API Key** field, paste your Referral SaaSquatch API Key. ### Step 3: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables and columns * All tables and columns For Referral SaaSquatch integrations, you can select: 1. **Individual tables and columns** 2. **All tables and columns** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate. 4. Repeat this process for all the tables and columns you want to replicate. 5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections. ### Step 4: Define the historical replication start date The Sync Historical Data setting defines the starting date for your Referral SaaSquatch integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. Change this setting if you want to replicate data beyond Referral SaaSquatch’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 5: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins. Referral SaaSquatch integrations support the following replication scheduling methods: * [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Initial and historical replication jobs After you finish setting up Referral SaaSquatch, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page. For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### Free historical data loads The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## Referral SaaSquatch table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 2** of this integration. This is the latest version of the Referral SaaSquatch integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### referrals The `referrals` table contains info about all of the referrals in your Referral SaaSquatch tenant. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [Referral SaaSquatch documentation](https://docs.referralsaasquatch.com/api/methods/#open_list_referrals "Opens in new tab: Referral SaaSquatch documentation")


[referrals schema on GitHub](https://github.com/singer-io/tap-referral-saasquatch/blob/master/tap_referral_saasquatch/schemas/referrals.json "Opens in new tab: referrals schema on GitHub")


[Referral SaaSquatch API method](https://docs.referralsaasquatch.com/api/methods/#list_referrals "Opens in new tab: Referral SaaSquatch API method") | referrals table foreign keys | Join referrals with | on | | --- | --- | | [reward_balances](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#reward-balances) | ```
referrals.referredUser = reward_balances.userId
```

```
referrals.referrerUser = reward_balances.userId
```

```
referrals.referredAccount = reward_balances.accountId
```

```
referrals.referrerAccount = reward_balances.accountId
``` | | [users](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#users) | ```
referrals.referredUser = users.id
```

```
referrals.referrerUser = users.id
```

```
referrals.referredAccount = users.accountId
```

```
referrals.referrerAccount = users.accountId
``` | referrals table schema | **dateConverted**

DATE-TIME | | --- | | **dateModerated**

DATE-TIME | | **dateReferralEnded**

DATE-TIME | | **dateReferralPaid**

DATE-TIME | | **dateReferralStarted**

DATE-TIME | | **id**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand id

| | **programId**


STRING | | **referredAccount**


STRING | | **referredModerationStatus**


STRING | | **referredReward**


STRING | | **referredUser**


STRING | | **referrerAccount**


STRING | | **referrerModerationStatus**


STRING | | **referrerReward**


STRING | | **referrerUser**


STRING | ### reward\_balances The `reward_balances` table contains info about the balances for all rewards. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | userId

accountId | | **Useful links** | [reward_balances schema on GitHub](https://github.com/singer-io/tap-referral-saasquatch/blob/master/tap_referral_saasquatch/schemas/reward_balances.json "Opens in new tab: reward_balances schema on GitHub")


[Referral SaaSquatch API method](https://docs.referralsaasquatch.com/api/methods#list_balances "Opens in new tab: Referral SaaSquatch API method") | reward\_balances table foreign keys | Join reward\_balances with | on | | --- | --- | | [referrals](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#referrals) | ```
reward_balances.userId = referrals.referredUser
```

```
reward_balances.userId = referrals.referrerUser
```

```
reward_balances.accountId = referrals.referredAccount
```

```
reward_balances.accountId = referrals.referrerAccount
``` | | [users](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#users) | ```
reward_balances.userId = users.id
```

```
reward_balances.accountId = users.accountId
``` | reward\_balances table schema | **accountId**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand accountId

| | --- | | **amount**


INTEGER | | **type**


STRING | | **unit**


STRING | | **userId**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand userId

| ### users The `users` table contains info about the users in your Referral SaaSquatch tenant. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id

accountId | | **Useful links** | [users schema on GitHub](https://github.com/singer-io/tap-referral-saasquatch/blob/master/tap_referral_saasquatch/schemas/users.json "Opens in new tab: users schema on GitHub")


[Referral SaaSquatch API method](https://docs.referralsaasquatch.com/api/methods#list_users "Opens in new tab: Referral SaaSquatch API method") | users table foreign keys | Join users with | on | | --- | --- | | [referrals](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#referrals) | ```
users.id = referrals.referredUser
```

```
users.id = referrals.referrerUser
```

```
users.accountId = referrals.referredAccount
```

```
users.accountId = referrals.referrerAccount
``` | | [reward_balances](https://help.qlik.com/en-US/stitch/integrations/saas/referral-saasquatch#reward-balances) | ```
users.id = reward_balances.userId
```

```
users.accountId = reward_balances.accountId
``` | users table schema | **accountId**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand accountId

| | --- | | **dateCreated**

DATE-TIME | | **email**


STRING | | **emailHash**


STRING | | **emailShareLink**


STRING | | **facebookShareLink**


STRING | | **firstName**


STRING | | **firstSeenIP**


STRING | | **id**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand id

| | **imageUrl**


STRING | | **lastName**


STRING | | **lastSeenIP**


STRING | | **linkedinShareLink**


STRING | | **locale**


STRING | | **referralSource**


STRING | | **shareLink**


STRING | | **twitterShareLink**


STRING |