Buttondown logo

Subscriber referrals

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/subscribers/{id_or_email}/referrals"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("GET", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "results": [
        {
            "id": "sub_0k28edc3fw896bp4mrhc535z5k",
            "creation_date": "2020-09-29T00:00:00+00:00",
            "avatar_url": "",
            "churn_date": null,
            "commenting_disabled": false,
            "email_address": "telemachus@buttondown.email",
            "gift_subscription_message": "",
            "ip_address": null,
            "last_click_date": null,
            "last_open_date": null,
            "delivered_count": null,
            "open_count": null,
            "clicked_count": null,
            "open_rate": null,
            "click_rate": null,
            "metadata": {
                "name": "Telemachus"
            },
            "notes": "",
            "purchased_by": null,
            "purchased_message": null,
            "referral_code": "",
            "referrer_url": "",
            "risk_score": null,
            "secondary_id": 1,
            "source": "organic",
            "stripe_coupon": null,
            "stripe_customer_id": null,
            "subscriber_import_id": null,
            "tags": [],
            "transitions": [],
            "email_transitions": [],
            "form_id": null,
            "firewall_reasons": [],
            "type": "unactivated",
            "undeliverability_date": null,
            "undeliverability_reason": null,
            "unsubscription_date": null,
            "unsubscription_reason": "",
            "upgrade_date": null,
            "utm_campaign": "",
            "utm_medium": "",
            "utm_source": "",
            "stripe_customer": null
        }
    ],
    "count": 1
}