api-docs-icon

Get All Campaigns

GET
/ api/ v1/ campaigns

Get all campaigns for this account. The response will contain an array of campaign objects. Within the return data array, each campaign will have a number of stats and flags. Flag values are outlined below:

campaign_type

  • 1 - smart send
  • 2 - automated file
  • 3 - triggered drip

live mode

  • 1 - the campaign is live
  • 0 - the campaign is in test mode

status

  • 1 - Sent
  • 0 - Pending
  • -1 - Draft Mode
  • 9 or 10 - Processing

campaign_type

  • 0 - letter
  • 1 - 4x6 postcard
  • 2 - 6x9 postcard
  • 3 - 6x11 postcard
  • 6 - 12x9 bifold
  • 7 - 6x18 bifold

Response

application/json
array[object]
object

Code Examples

Response