v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Subscribers

Get Referrals

List subscribers referred by a specific subscriber

get/subscribers/{id_or_email}/referrals

Path parameters

id_or_emailstring required

Query parameters

pageinteger

The page number of the paginated response.

Example:1

The page number of the paginated response.

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
    }
  ]
}