BUbuttondown
Subscribers

Get Referrals

Changed on

List subscribers referred by a specific subscriber

get/subscribers/{id_or_email}/referrals

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/subscribers/{id_or_email}/referrals
  • Auth
    API key in header Authorization

Path parameters

id_or_emailstring required

Query parameters

pageinteger

The page number of the paginated response.

Example:1

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.

Example response

{
  "results": [
    {
      "country": "US",
      "email_address": "telemachus@buttondown.email",
      "delivered_count": 12,
      "open_count": 7,
      "clicked_count": 3,
      "open_rate": 0.5833,
      "click_rate": 0.25
    }
  ]
}

Changes

  • 594190e20eb7Revision changes
    • warning

      added the new comment_text_contains_link enum value to the //// response property for the response status

  • 8fff9c6b1347Revision changes
    • info

      removed the email_address_noreply_local_part enum value from the //// response property for the response status