Skip to main content
GET
/
list_campaigns
List all campaigns
curl --request GET \
  --url https://yourdomain.com/list_campaigns \
  --cookie admin_cookie=
[
  {
    "name": "<string>",
    "email": "<string>",
    "mail_server": "<string>",
    "smtp_from": "<string>",
    "phishing_link": "<string>",
    "id_parameter": "<string>",
    "delay": 123,
    "secure": 123,
    "username": "<string>",
    "password": "<string>",
    "dkim": 123,
    "scheduled_start": 123,
    "start_timestamp": 123,
    "end_timestamp": 123,
    "is_sending": 123,
    "market_id": 123
  }
]

Authorizations

Admin cookie authentication (configurable in config.json)

Response

Successful response

name
string

Campaign name

email
string

Raw email message

mail_server
string

Mail server hostname

smtp_from
string

SMTP mail from field

Base phishing link URL

id_parameter
string

Tracking ID parameter name

delay
integer

Delay between emails in seconds

secure
integer

Use TLS (1 = yes, 0 = no)

username
string

SMTP username for authentication

password
string

SMTP password for authentication

dkim
integer

DKIM sign messages (1 = yes, 0 = no)

scheduled_start
integer | null

Unix timestamp for scheduled start

start_timestamp
integer | null

Unix timestamp when campaign started

end_timestamp
integer | null

Unix timestamp when campaign ended

is_sending
integer

Campaign sending status (1 = sending, 0 = stopped)

market_id
integer

Phishmarket template ID if applicable