GET
/
referrals
Get all referrals or by ID/email/externalId
curl --request GET \
  --url https://www.pushlapgrowth.com/api/v1/referrals \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "jsmith@example.com",
    "referredUserExternalId": "<string>",
    "plan": "<string>",
    "status": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<uuid>

The ID of the referral to retrieve

​
affiliateId
string<uuid>

The affiliate ID associated with the referral

​
affiliateEmail
string<email>

The email of the affiliate associated with the referral

​
externalId
string

The external ID of the referred user

Response

A list of referrals or a single referral

​
id
string<uuid>

The referral ID

​
affiliateId
string<uuid>

The affiliate ID associated with the referral

​
name
string

Name of the referred user

​
email
string<email>

Email of the referred user

​
referredUserExternalId
string

The external ID of the referred user. This will be an ID you actively maintain that identifies the user on your server (for example, the User ID in your database, or Stripe Customer ID)

​
plan
string

The plan associated with the referred user

​
status
string

Status of the referral (active/inactive)