List all campaigns

This API endpoint fetches a list of all campaigns.

This endpoint will list all the campaigns on a specific workspace.

Endpoint

cURL

GET https://api.mailstand.com/campaigns?workspace={{workspace}}&page={{page}}&display={{display}}

Parameters

Field	Required	Description
workspace	true	The workspace ID that you want to query
display	true	How many campaigns to display/show per page
page	true	The page you want to be on

API Call Example

Text

GET https://api.mailstand.com/campaigns?workspace=space_EVGG8f0vtZLHUI49bfGGTLBXk&page=1&display=25

200 Response

JSON

{
    "status": "ok",
    "headers": [
        "status",
        "name",
        "steps",
        "contacts",
        "opens",
        "initials",
        "interested",
        "replies",
        "bounces",
        "last_activity"
    ],
    "data": [
        {
            "id": "camp_a0lZ6vQ5BDa0ezgfnExUo9v7s",
            "status": "live",
            "name": "Campaign One",
            "steps": 1,
            "contacts": 33,
            "opens": 87.5,
            "initials": 32,
            "interested": 0,
            "replies": 0,
            "bounces": 0,
            "last_activity": "1 day ago",
            "opens_num": 28,
            "replies_num": 0,
            "bounces_num": 0,
            "interested_num": 0,
            "days_left": 0,
            "days_left_date": "Complete",
            "days_left_display": "0 days",
            "created": 1658256658
        },
        {
            "id": "camp_kPCzB309nnKZUULbWoxmFEQFM",
            "status": "live",
            "name": "Campaign Two",
            "steps": 1,
            "contacts": 1,
            "opens": 0,
            "initials": 1,
            "interested": 0,
            "replies": 100,
            "bounces": 0,
            "last_activity": "4 days ago",
            "opens_num": 0,
            "replies_num": 1,
            "bounces_num": 0,
            "interested_num": 0,
            "days_left": 0,
            "days_left_date": "Complete",
            "days_left_display": "0 days",
            "created": 1658177883
        },
        {
            "id": "camp_PyRcQF5j5WJpEdslFW1YjK8Wv",
            "status": "draft",
            "name": "Campaign Three",
            "steps": 1,
            "contacts": 0,
            "opens": 0,
            "initials": 0,
            "interested": 0,
            "replies": 0,
            "bounces": 0,
            "last_activity": "4 days ago",
            "opens_num": 0,
            "replies_num": 0,
            "bounces_num": 0,
            "interested_num": 0,
            "days_left": 0,
            "days_left_date": "Complete",
            "days_left_display": "0 days",
            "created": 1658177591
        },
        {
            "id": "camp_6ejOBicl5K7hNvmjEwdjt0cak",
            "status": "live",
            "name": "Campaign Four",
            "steps": 1,
            "contacts": 2,
            "opens": 0,
            "initials": 2,
            "interested": 0,
            "replies": 100,
            "bounces": 0,
            "last_activity": "4 days ago",
            "opens_num": 0,
            "replies_num": 2,
            "bounces_num": 0,
            "interested_num": 0,
            "days_left": 0,
            "days_left_date": "Complete",
            "days_left_display": "0 days",
            "created": 1658173900
        },
        {
            "id": "camp_oh60mAbZnGXIwSHy8W9qnn7X8",
            "status": "paused",
            "name": "Campaign Five",
            "steps": 1,
            "contacts": 499,
            "opens": 33.33,
            "initials": 3,
            "interested": 33.33,
            "replies": 33.33,
            "bounces": 0,
            "last_activity": "8 days ago",
            "opens_num": 1,
            "replies_num": 1,
            "bounces_num": 0,
            "interested_num": 1,
            "days_left": 0,
            "days_left_date": "Complete",
            "days_left_display": "0 days",
            "created": 1657286308
        }
    ],
    "total_found": 5,
    "current_page": 1,
    "total_pages": 1
}

Response Fields

Field	Type	Description
headers	array	These are the headers that are saved to the user's settings. This is used to display the columns within the platform.
data[id]	string	Unique identifier for the campaign. It always starts with camp_.
data[status]	string	The status of the campaign. It can either be draft, live, or `paused.
data[name]	string	Name of the campaign.
data[steps]	number	Number of steps the campaign has.
data[contacts]	number	Number of contacts the campaign has.
data[opens]	number	Open percentage of the campaign.
data[replies]	number	Reply percentage of the campaign.
data[bounces]	number	Bounce percentage of the campaign.
data[opens_num]	number	Number of opens on the campaign.
data[replies_numb]	number	Number of replies on the campaign.
data[bounces_num]	number	Number of boun on the campaign.
data[days_left]	number	The estimated number of days until the campaign will end.
data[days_left_date]	unix	The estimated unix timestamp of when the campaign should be ending.
data[days_left_display]		The printed pretty timestamp of when the campaign should be ending.
last_activity	string	How long ago there was an activity on the campaign.
created	number	The time the campaign was created at in unix timestamp.
total_found	number	The total number of campaigns found in this search.
current_page	number	The page you're currently on.
total_pages	number	The number of total pages that you can paginate through on this search.