Skip to main content
GET
/
campaigns
curl -X GET https://api.thinnest.ai/campaigns \
  -H "Authorization: Bearer $THINNESTAI_API_KEY"
{
  "campaigns": [
    {
      "id": "camp_a1b2c3d4",
      "name": "Follow-up Campaign",
      "status": "running",
      "type": "voice",
      "agent_id": "ag_c47e7c97_b2f2",
      "total_contacts": 150,
      "completed": 45,
      "failed": 3,
      "created_at": "2026-03-07T14:00:00Z"
    }
  ],
  "total": 1
}
curl -X GET https://api.thinnest.ai/campaigns \
  -H "Authorization: Bearer $THINNESTAI_API_KEY"

Query Parameters

status
string
default:"All"
Filter by: draft, running, paused, completed, failed
limit
integer
default:"20"
Maximum number of campaigns to return
offset
integer
default:"0"
Pagination offset

Response 200

{
  "campaigns": [
    {
      "id": "camp_a1b2c3d4",
      "name": "Follow-up Campaign",
      "status": "running",
      "type": "voice",
      "agent_id": "ag_c47e7c97_b2f2",
      "total_contacts": 150,
      "completed": 45,
      "failed": 3,
      "created_at": "2026-03-07T14:00:00Z"
    }
  ],
  "total": 1
}

Response Fields

campaigns[].id
string
Campaign ID
campaigns[].name
string
Campaign name
campaigns[].status
string
draft, running, paused, completed, failed
campaigns[].type
string
voice or sms
campaigns[].total_contacts
integer
Total contacts in the campaign
campaigns[].completed
integer
Successfully reached contacts
campaigns[].failed
integer
Failed contact attempts

Errors

CodeDescription
401Missing or invalid authentication

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
string | null
channel
string | null

Response

Successful Response