List Campaigns via the API

List the marketing campaigns in your AhaSend account, newest first, with their status, subject, sender and send times. Filter the list by status.

GET /v2/accounts/{account_id}/campaigns

AhaSend Go SDK

Go

package main

import (
  "context"
  "fmt"
  "log"
  "os"

  "github.com/AhaSend/ahasend-go"
  "github.com/AhaSend/ahasend-go/api"
  "github.com/AhaSend/ahasend-go/models/common"
  "github.com/AhaSend/ahasend-go/models/requests"
  "github.com/google/uuid"
)

func main() {
  client := api.NewAPIClient(api.WithAPIKey(os.Getenv("AHASEND_API_KEY")))
  accountID := uuid.MustParse(os.Getenv("AHASEND_ACCOUNT_ID"))
  ctx := context.Background()

  // Leave Status nil to list campaigns in every status.
  response, _, err := client.CampaignsAPI.ListCampaigns(ctx, accountID, requests.ListCampaignsParams{
    Status: ahasend.String(common.CampaignStatusScheduled),
    Limit:  ahasend.Int32(100),
  })
  if err != nil {
    log.Fatalf("Error listing campaigns: %v", err)
  }
  for _, campaign := range response.Data {
    if campaign.SendAt != nil {
      fmt.Printf("%s %s sends at %s\n", campaign.ID, campaign.Name, campaign.SendAt)
    }
  }
}

200

{
  "object": "list",
  "data": [
    {
      "object": "campaign",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "subject": "<string>",
      "preheader": "<string>",
      "from": {
        "email": "[e-mail]",
        "name": "Example Corp"
      },
      "reply_to": "[e-mail]",
      "status": "draft",
      "status_reason": "<string>",
      "send_at": "2023-11-07T05:31:56Z",
      "send_resumes_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6MTIzNH0="
  }
}

The AhaSend API returns the account’s marketing campaigns, newest first. Access requires campaigns:read.

Use status to list only the campaigns in one status. Each campaign is listed without its lists, its design and its issues. To read them, use Get Campaign.

Related Guides

• API authentication, Permission scopes, Create Campaign.
• Campaign status, API errors, API rate limits.

Authorizations

Authorization · string · header · required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

Path Parameters

account_id · string<uuid> · required

Account ID

Query Parameters

status · enum<string>

Only campaigns in this status. Where the campaign is in its life. Only a draft can be changed or deleted.

• draft: being prepared.
• validating: scheduled, and its lists are being checked.
• waiting_for_review: held for a review before it sends.
• scheduled: accepted, waiting for its send time.
• sending: sending now.
• paused: sending stopped for now; status_reason says why.
• sent: every message was sent.
• canceled: stopped before it finished; status_reason says why.
• failed: could not be sent; status_reason says why.

Available options: draft, validating, waiting_for_review, scheduled, sending, paused, sent, canceled, failed

limit · integer · default: 100

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100

after · string

Pagination cursor for the next page. Provide the value from next_cursor in the response.

before · string

Pagination cursor for the previous page. Provide the value from previous_cursor in the response.

Response

200

application/json

Paginated campaigns

object · enum<string> · required

Object type identifier

Available options: list

data · object[] · required

Array of campaigns

Show child attributes

pagination · object · required

Show child attributes

Example:

{
  "has_more": true,
  "next_cursor": "eyJpZCI6MTIzNH0="
}