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

Changes

Changed in 3 of the 11 revisions of this API.42

  • e0ac41d864642See the full diff
    • ○

      removed the email_address_cleantalk_score enum value from the results/items/firewall_reasons/items/code response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the ip_address_cleantalk_score enum value from the results/items/firewall_reasons/items/code response property for the response status 200

      response-property-enum-value-removed

  • 3a702c095d223See the full diff
    • ●

      added the new email_address_plus_variant_accounts enum value to the results/items/firewall_reasons/items/code response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new registration_without_prior_page_visit enum value to the results/items/firewall_reasons/items/code response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new username_shannon_entropy enum value to the results/items/firewall_reasons/items/code response property for the response status 200

      response-property-enum-value-added

  • 71b271a0f44a1See the full diff
    • ●

      added the new email_address_domain_burst enum value to the results/items/firewall_reasons/items/code response property for the response status 200

      response-property-enum-value-added