Campaigns

List campaigns

Retrieve paginated list of campaigns for the authenticated organization. Campaigns can be filtered and sorted.

get/api/v1/campaigns

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/campaigns
  • Auth: bearerAuth (a scheme the document does not define)

Query parameters

pageinteger
limitinteger
phoneNumberIdstring uuid

Filter campaigns to those with an active agent associated with this phone number ID

type'calls' | 'text' | 'sms' | 'whatsapp' | 'email'

Filter campaigns by channel type

searchstring

Search campaigns by name (case-insensitive)

view'full' | 'summary'

summary omits heavy fieldSchema payloads for list and selector UIs

Response

Paginated list

successtrue required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Q1 2025 Sales Outreach",
      "description": "Quarterly sales campaign targeting high-value prospects",
      "type": "calls",
      "status": "active",
      "language": "es",
      "timezone": "America/Mexico_City",
      "maxAttemptsPerRun": 3,
      "retryTimesOfDay": [
        "14:30",
        "17:00"
      ],
      "createdAt": "2025-03-10T12:00:00Z",
      "updatedAt": "2025-03-10T15:30:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.