> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partnero.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Newsletter referral overview

> API endpoints for Newsletter Referral programs

The Newsletter Referral API provides endpoints for managing newsletter subscriber referral programs.

## Key Concepts

* **Subscriber**: A newsletter subscriber who can share referral links
* **Referred Subscriber**: A new subscriber who signed up via a referral link
* **Rewards**: Benefits earned when referrals reach milestones

## Available Endpoints

<CardGroup cols={2}>
  <Card title="Subscribers" icon="envelope" href="/api-reference/newsletter/subscribers">
    Create and manage newsletter subscribers
  </Card>

  <Card title="Program" icon="gear" href="/api-reference/newsletter/program">
    Program settings and configuration
  </Card>
</CardGroup>

## Program Overview

Get newsletter program details:

```bash theme={null}
GET https://api.partnero.com/v1/program
```

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "data": {
      "id": "HTA1FEFM",
      "name": "My Newsletter Program",
      "esp_type": "custom",
      "esp_type_name": "Custom",
      "total_subscribers": 1,
      "total_referring": 0,
      "total_referred": 0,
      "created_at": "2025-04-30T15:15:12.000000Z"
    },
    "status": 1
  }
  ```
</ResponseExample>

## ESP Integration

Newsletter programs can integrate with Email Service Providers:

* **Custom** - Manual subscriber management
* **Mailchimp** - Automatic sync with Mailchimp
* **MailerLite** - Automatic sync with MailerLite
* **Kit (ConvertKit)** - Automatic sync with Kit
* **Beehiiv** - Automatic sync with Beehiiv