v1

latestOpenAPI 3.0.02026-07-2633090.6 KB

campaign

Get All Campaigns

Retrieves a paginated list of campaigns for the current user with optional call count information.

get/campaign/all

Query parameters

call_countboolean

Whether to include call count for each campaign (default: true).

limitinteger

Maximum number of campaigns to return (default: 10).

offsetinteger

Number of campaigns to skip for pagination (default: 0).

Headers

X-API-KEYstring required

Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

List of campaigns retrieved successfully.

Example response

{
  "campaigns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Q4 Sales Campaign",
      "campaign_status": "completed",
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-15T16:45:00Z",
      "campaign_start_time": "2024-01-16T09:00:00Z",
      "campaign_end_time": "2024-01-16T17:00:00Z",
      "total_count": 150,
      "registered_count": 120,
      "completed_count": 85
    }
  ],
  "pagination": {
    "total": 25,
    "limit": 10
  }
}