List campaigns

GET

/campaigns

curl --request GET \
  --url https://app.whatsetter.com/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'

• Production

The workspace’s campaigns: use campaign_id to filter /leads and /conversations, and whatsapp_connected to know whether the campaign’s number can currently send. Requires scope campaigns:read.

Authorizations

• bearerAuth

Responses

200

The workspace’s campaigns

Media typeapplication/json

object

data

Array<object>

object

id

string

campaign_id

The value used by /leads?campaign_id= and lead objects.

string | null

name

string | null

status

unknown for an internal value outside this list.

string | null

Allowed values: active draft paused archived unknown

purpose

setter = 1:1 conversations; group = a WhatsApp group campaign (its participants are left out of /leads unless filtered). unknown for an internal value outside this list.

string | null

Allowed values: setter group unknown

whatsapp_connected

boolean

created_at

string format: date-time

Example

{
  "data": [
    {
      "status": "active",
      "purpose": "setter"
    }
  ]
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

The key lacks the required scope

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}