Referral

A Referral tracks who has referred whom.

List referrals

get

List all of the referrals in your Referral SaaSquatch by impact.com tenant. This method supports pagination and filtering.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t"

Query parameters

referringAccountIdstringOptional

When included, filters the results to only referrals that were referred by users with this AccountId

referringUserIdstringOptional

When included, filters the results to only referrals that were referred by users with this UserId

dateReferralPaidstringOptional

When included, filters the results by an exact timestamp or a comma-separated range for when the referral was paid.

dateReferralEndedstringOptional

When included, filters the results by an exact timestamp or a comma-separated range for when the referral ended.

referredModerationStatusstring · enumOptional

Filters the result to only include referred users with that status: PENDING, APPROVED or DENIED.

Possible values:

referrerModerationStatusstring · enumOptional

Filters the result to only include referrers with that status: PENDING, APPROVED or DENIED.

Possible values:

limitintegerOptional

A limit on the number of results returned.

Default: 10

offsetintegerOptional

Offsets the first result to return in the list for pagination.

Default: 0

Responses

200

A list of referrals.

application/json

countintegerOptionalExample: 1

totalCountintegerOptionalExample: 1

default

Unexpected Error

application/json

get

/{tenant_alias}/referrals

cURL

curl -L \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/referrals' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "count": 1,
  "totalCount": 1,
  "referrals": [
    {
      "id": "6a1709e0eb067e53ef651c29",
      "referralCodeUsed": "BOBTESTERSON",
      "shareLinkUsed": null,
      "moderationStatus": "ACTIONED",
      "referredModerationStatus": "APPROVED",
      "referrerModerationStatus": "APPROVED",
      "fraudSignals": null,
      "programId": null,
      "dateReferralStarted": 1779894752097,
      "dateReferralPaid": null,
      "dateReferralEnded": null,
      "dateModerated": 1779894752099,
      "dateConverted": null,
      "dateModified": 1779894752494,
      "dateUserModified": null
    }
  ]
}

Lookup a Referral

get

Looks up a single Referral object by its associated id.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t"

referralIdstringRequired

The id of the referral to look up

Responses

200

Referral found.

application/json

A link between the user/account of the referrer and the new referred user/account.

idstringOptionalExample: 6a1709e0eb067e53ef651c29

referralCodeUsedstring · nullableOptionalExample: BOBTESTERSON

shareLinkUsedstring · nullableOptional

moderationStatusstring · enumOptionalExample: ACTIONEDPossible values:

referredModerationStatusstring · enumOptionalExample: APPROVEDPossible values:

referrerModerationStatusstring · enumOptionalExample: APPROVEDPossible values:

dateReferralStartedinteger · int64OptionalExample: 1779894752097

dateReferralPaidinteger · int64 · nullableOptional

dateReferralEndedinteger · int64 · nullableOptional

dateModeratedinteger · int64 · nullableOptionalExample: 1779894752099

dateConvertedinteger · int64 · nullableOptional

Unix timestamp (milliseconds) when the referral converted.

dateModifiedinteger · int64Optional

Unix timestamp (milliseconds) when the referral was last modified.

Example: 1779894752494

dateUserModifiedinteger · int64 · nullableOptional

Unix timestamp (milliseconds) when the referred user was last modified.

programIdstring · nullableOptional

The ID of the program this referral belongs to.

404

Referral NOT found.

application/json

default

Unexpected Error

application/json

get

/{tenant_alias}/referrals/{referralId}

cURL

curl -L \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/referrals/{referralId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "id": "6a1709e0eb067e53ef651c29",
  "referredUser": {
    "id": "abc123",
    "accountId": "abc123",
    "firstName": "Bob",
    "lastName": "Testerson",
    "lastInitial": "T",
    "email": "[email protected]",
    "emailHash": "714ed06b2d5c95b93d499a3be731c19f",
    "imageUrl": "",
    "referralCode": "BOBTESTERSON",
    "cookieId": "abc123cookie",
    "paymentProviderId": "pay_abc123",
    "locale": "en_US",
    "countryCode": "US",
    "referralSource": "DIRECT",
    "firstSeenIP": "203.0.113.42",
    "lastSeenIP": "203.0.113.42",
    "dateCreated": 1774386824964,
    "dateBlocked": null,
    "shareLinks": {}
  },
  "referrerUser": {
    "id": "abc123",
    "accountId": "abc123",
    "firstName": "Bob",
    "lastName": "Testerson",
    "lastInitial": "T",
    "email": "[email protected]",
    "emailHash": "714ed06b2d5c95b93d499a3be731c19f",
    "imageUrl": "",
    "referralCode": "BOBTESTERSON",
    "cookieId": "abc123cookie",
    "paymentProviderId": "pay_abc123",
    "locale": "en_US",
    "countryCode": "US",
    "referralSource": "DIRECT",
    "firstSeenIP": "203.0.113.42",
    "lastSeenIP": "203.0.113.42",
    "dateCreated": 1774386824964,
    "dateBlocked": null,
    "shareLinks": {}
  },
  "referredReward": {
    "id": "6a1709e0eb067e53ef651c3b",
    "type": "CREDIT",
    "uniqueId": null,
    "dateCreated": 1779894752360,
    "dateScheduledFor": null,
    "dateGiven": 1779894752451,
    "dateExpires": null,
    "dateCancelled": null,
    "accountId": "abc123",
    "userId": "abc123",
    "cancellable": true,
    "rewardSource": "REFERRED",
    "programId": null,
    "programRewardKey": null,
    "globalRewardKey": null,
    "referralId": "6a1709e0eb067e53ef651c29",
    "unit": "CENTS",
    "assignedCredit": 100,
    "redeemedCredit": 0,
    "name": "Dollar Credit",
    "currency": null,
    "redemptions": null
  },
  "referrerReward": {
    "id": "6a1709e0eb067e53ef651c3b",
    "type": "CREDIT",
    "uniqueId": null,
    "dateCreated": 1779894752360,
    "dateScheduledFor": null,
    "dateGiven": 1779894752451,
    "dateExpires": null,
    "dateCancelled": null,
    "accountId": "abc123",
    "userId": "abc123",
    "cancellable": true,
    "rewardSource": "REFERRED",
    "programId": null,
    "programRewardKey": null,
    "globalRewardKey": null,
    "referralId": "6a1709e0eb067e53ef651c29",
    "unit": "CENTS",
    "assignedCredit": 100,
    "redeemedCredit": 0,
    "name": "Dollar Credit",
    "currency": null,
    "redemptions": null
  },
  "referralCodeUsed": "BOBTESTERSON",
  "shareLinkUsed": null,
  "moderationStatus": "ACTIONED",
  "referredModerationStatus": "APPROVED",
  "referrerModerationStatus": "APPROVED",
  "fraudSignals": {
    "name": {
      "message": "text",
      "score": 1
    },
    "ip": {
      "message": "text",
      "score": 1
    },
    "email": {
      "message": "text",
      "score": 1
    },
    "rate": {
      "message": "text",
      "score": 1
    }
  },
  "dateReferralStarted": 1779894752097,
  "dateReferralPaid": null,
  "dateReferralEnded": null,
  "dateModerated": 1779894752099,
  "dateConverted": null,
  "dateModified": 1779894752494,
  "dateUserModified": null,
  "programId": null
}

Moderate referrals

post

Moderates one or several referrals by either approving or denying.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t"

Body

A request to perform one or several moderation actions.

Responses

200

Success

No content

default

Unexpected Error

application/json

post

/{tenant_alias}/referrals/moderate

cURL

curl -L \
  --request POST \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/referrals/moderate' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: */*'

No content

List referrals (Open Endpoint)

get

Lists all of the referrals involving the given user. This is an Open Endpoint and is disabled by default.

Authorizations

AuthorizationstringRequired

Authorize your requests using a tenant's API Key.

Path parameters

tenant_aliasstringRequired

Tenant being referenced. E.g. "aboih12h16t"

Query parameters

referringAccountIdstringOptional

Filters for referrals where this AccountId was the Referrer.

referringUserIdstringOptional

Filters for referrals where this UserId was the Referrer.

referredAccountIdstringOptional

Filters for referrals where this AccountId was the Referred User.

referredUserIdstringOptional

Filters for referrals where this UserId was the Referred User.

limitintegerOptional

A limit on the number of results returned.

Default: 10

offsetintegerOptional

Offsets the first result to return in the list for pagination.

Default: 0

Responses

200

A list of referrals.

application/json

countintegerOptionalExample: 1

totalCountintegerOptionalExample: 1

default

Unexpected Error

application/json

get

/{tenant_alias}/open/referrals

cURL

curl -L \
  --url 'https://app.referralsaasquatch.com/api/v1/{tenant_alias}/open/referrals' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

{
  "count": 1,
  "totalCount": 1,
  "referrals": [
    {
      "id": "6a1709e0eb067e53ef651c29",
      "referralCodeUsed": "BOBTESTERSON",
      "shareLinkUsed": null,
      "moderationStatus": "ACTIONED",
      "referredModerationStatus": "APPROVED",
      "referrerModerationStatus": "APPROVED",
      "fraudSignals": null,
      "programId": null,
      "dateReferralStarted": 1779894752097,
      "dateReferralPaid": null,
      "dateReferralEnded": null,
      "dateModerated": 1779894752099,
      "dateConverted": null,
      "dateModified": 1779894752494,
      "dateUserModified": null
    }
  ]
}

PreviousReferral Overview NextModels

Last updated 27 days ago