List referrals

get

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

List all of the referrals in your Advocate tenant. This method is the primary way of getting a full 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.

You can also use the query parameters for referringAccountId and referringUserId to filters this list of referrals to only include those made by a given user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 referrals that were referred friends with this AccountId

referringUserId

string

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

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 referred 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

200A list of referrals

defaultUnexpected Error