Skip to main content
GET
/
api
/
v1
/
campaigns
Lista kampanii
curl --request GET \
  --url https://api.example.com/api/v1/campaigns
{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": 456,
        "name": "Black Friday Sale 2024",
        "subject": "50% OFF Everything - Limited Time!",
        "status": "SENT",
        "total_recipients": 10000,
        "created_at": "2024-12-01T10:00:00",
        "sent_at": "2024-12-01T14:30:00"
      },
      {
        "id": 455,
        "name": "December Newsletter",
        "subject": "Year-end updates and special offers",
        "status": "SENT",
        "total_recipients": 5000,
        "created_at": "2025-12-01T10:00:00",
        "sent_at": "2025-12-15T14:00:00"
      }
    ],
    "page": 0,
    "size": 20,
    "totalElements": 45,
    "totalPages": 3
  }
}

​
Parametry zapytania

​
status
string
Filtruj po statusie kampanii: DRAFT, SCHEDULED, SENDING, SENT, FAILED
​
page
integer
default:"0"
Numer strony dla paginacji (indeksowany od 0)
​
size
integer
default:"20"
Liczba kampanii na stronę

​
Odpowiedź

​
success
boolean
Wskazuje czy żądanie zakończyło się sukcesem
​
data
object
Stronicowane dane kampanii

​
Przykład

curl https://api.mailist.com/api/v1/campaigns?status=SENT&page=0&size=20 \
  -H "X-API-Key: YOUR_API_KEY"

​
Odpowiedź

{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": 456,
        "name": "Black Friday Sale 2024",
        "subject": "50% OFF Everything - Limited Time!",
        "status": "SENT",
        "total_recipients": 10000,
        "created_at": "2024-12-01T10:00:00",
        "sent_at": "2024-12-01T14:30:00"
      },
      {
        "id": 455,
        "name": "December Newsletter",
        "subject": "Year-end updates and special offers",
        "status": "SENT",
        "total_recipients": 5000,
        "created_at": "2025-12-01T10:00:00",
        "sent_at": "2025-12-15T14:00:00"
      }
    ],
    "page": 0,
    "size": 20,
    "totalElements": 45,
    "totalPages": 3
  }
}

​
Statusy kampanii

  • DRAFT: Kampania jest tworzona
  • SCHEDULED: Kampania jest zaplanowana do wysłania w przyszłości
  • SENDING: Kampania jest obecnie wysyłana
  • SENT: Kampania została pomyślnie wysłana
  • FAILED: Wysyłanie kampanii nie powiodło się

​
Uwagi

  • Kampanie są sortowane według daty utworzenia (najnowsze pierwsze)
  • Ten endpoint wymaga uprawnienia campaigns.read dla klucza API
  • Użyj parametrów paginacji aby nawigować przez duże zestawy wyników