Referrals

Partner Program Referrals

A referral is one subscriber a partner program received from a partner — a reader who subscribed to the sponsor through a partner's recommendation.

List referrals

GET https://api.sparkloop.app/v3/publications/:publication_uuid/grow/partner_program/referrals

Paginated, newest first.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

Query Parameters

Name	Type	Description
expand	String	recommending_partner to inline the partner publication that drove the referral.

200: OK

{
  "referrals": [
    <Referral Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 9,
    "total_referrals": 412
  }
}

Get referral

GET https://api.sparkloop.app/v3/publications/:publication_uuid/grow/partner_program/referrals/:uuid

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.
uuid*	String	The referred subscriber's UUID (sub_…).

Query Parameters

Name	Type	Description
expand	String	recommending_partner.

200: OK

{
  "referral": <Referral Object>
}

404: Not Found

{
  "error": "Resource not found."
}