List referrals (Open Endpoint)

get https://app.referralsaasquatch.com/api/v1/{tenant_alias}/open/referrals

Lists all of the referrals involving the given user. This method is the primary way of getting a list of everyone that has made a referral and everyone that has been referred, and supports pagination using the parameters for limit and offset to iterate through a very large list of records.

Note: Either the referringAccountId and referringUserId or referredAccountId and referredUserId parameters are required, along with a read token for authenticaion.

This is an Open Endpoint and disabled by default. Contact support to enable the open endpoints.

Path Params

tenant_alias

string

required

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

Query Params

referringAccountId

string

When included, filters the results to only include referrals where this AccountId was the referring customer advocate.

referringUserId

string

When included, filters the results to only include referrals where this UserId was the referring customer advocate.

referredAccountId

string

When included, filters the results to only include referrals where this AccountId was the referred friend.

referredUserId

string

When included, filters the results to only include referrals where this UserId was the referred friend.

dateReferralStarted

string

When included, filters the results either to the exact timestamp if only one value is given, or a range if devided by a comma. I.E. 0,123412451 gives all referrals that started between 0 and 123412451.

dateReferralPaid

string

When included, filters the results either to the exact timestamp if only one value is given, or a range if devided by a comma. I.E. 0,123412451 gives all referrals that converted between 0 and 123412451.

dateReferralEnded

string

When included, filters the results either to the exact timestamp if only one value is given, or a range if devided by a comma. I.E. 0,123412451 gives all referrals that ended between 0 and 123412451.

referredModerationStatus

string

When included, filters the result to only include friends with that status. Statuses that are accepted: PENDING, APPROVED or DENIED.

referrerModerationStatus

string

When included, filters the result to only include customer advocate with that status. Statuses that are accepted: PENDING, APPROVED or DENIED.

limit

integer

Defaults to 10

A limit on the number of results returned. Defaults to 10.

offset

integer

Defaults to 0

When included offsets the first result returns in the list. Use this to paginate through a long list of results. Defaults to 0

Responses

Response body

object

count

integer

The number of results returned in this list, see totalCount for all rows.

totalCount

integer

The total number of results available overall, see count for the number of rows in this list.

referrals

array of objects

A list of Referral objects. This is the actual data in this list envelope.

referrals

object

string

Unique identifier for the Referral object

referredUser

object

An object describing an individual user. Users are used in Advocate to track people/contacts/leads. When a referral happens, it always happens between two Users.

referrerUser

object

An object describing an individual user. Users are used in Advocate to track people/contacts/leads. When a referral happens, it always happens between two Users.

referredReward

object

Rewards are used in Advocate to track the credits, discounts, gift cards and other prizes that a User earns.

referrerReward

object

Rewards are used in Advocate to track the credits, discounts, gift cards and other prizes that a User earns.

referralCodeUsed

string

The customer advocate's code that was used by the referred for the referral.

shareLinkUsed

string

The sharelink that was used by the referred for the referral.

moderationStatus

string

When referrals are manually managed, each referral has a PENDING state until it is explicitly moderated.

PENDING ACTIONED

referredModerationStatus

string

Used to identify the referred user's moderation status and affect Reward cancellation.

PENDING APPROVED DENIED

referrerModerationStatus

string

Used to identify the referring customer advocate's moderation status and affect Reward cancellation.

PENDING APPROVED DENIED

fraudSignals

object

Information about signals of potential fraud on the referral

dateReferralStarted

integer

Timestamp of when this referral was started.

dateReferralPaid

integer

Timestamp of when this referral was marked as PAID.

dateReferralEnded

integer

Timestamp of when this referral was ended.

dateModerated

integer

Timestamp of when this referral was last moderated.

Language

Credentials


     --url 'https://app.referralsaasquatch.com/api/v1/tenant_alias/open/referrals?limit=10&offset=0' \

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of referrals

defaultUnexpected Error