Skip to main content
GET
/
v1
/
program
Newsletter program
curl --request GET \
  --url https://api.example.com/v1/program
{
  "data": {
    "id": "HTA1FEFM",
    "name": "My Newsletter Program",
    "esp_type": "custom",
    "esp_type_name": "Custom",
    "total_subscribers": 150,
    "total_referring": 25,
    "total_referred": 45,
    "created_at": "2025-04-30T15:15:12.000000Z"
  },
  "status": 1
}

Get Program

Retrieve newsletter program details and statistics.
GET https://api.partnero.com/v1/program

Request

cURL
curl --location 'https://api.partnero.com/v1/program' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "data": {
    "id": "HTA1FEFM",
    "name": "My Newsletter Program",
    "esp_type": "custom",
    "esp_type_name": "Custom",
    "total_subscribers": 150,
    "total_referring": 25,
    "total_referred": 45,
    "created_at": "2025-04-30T15:15:12.000000Z"
  },
  "status": 1
}

Response Fields

FieldTypeDescription
idstringProgram public ID
namestringProgram name
esp_typestringEmail service provider type
esp_type_namestringESP display name
total_subscribersintegerTotal subscriber count
total_referringintegerSubscribers who have made referrals
total_referredintegerSubscribers who were referred

Delete Program

This permanently deletes the program and all associated data.
DELETE https://api.partnero.com/v1/program
{
  "status": 1
}