Skip to main content
GET
/
campaign
/
all
Get All Campaigns
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/all \
  --header 'X-API-KEY: <x-api-key>'
{
  "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,
    "offset": 0
  }
}
Return campaigns in the current workspace. Use this for campaign dashboards, monitoring pages, and post-run reconciliation after either the standard flow or the beta large-campaign flow.

​
Query guidance

  • Use limit and offset for pagination.
  • Use call_count=true when the UI needs call totals with each campaign.
  • Pair this endpoint with call history filtered by bulk_list_id for detailed call-level results.
  • For beta large campaigns, poll Upload status until CSV processing is complete before relying on campaign-level call progress.

​
Typical flow

  1. Upload contacts with Upload campaign contact list.
  2. Start calls with Start campaign.
  3. Monitor campaign state here.
  4. Inspect calls through Get call history.

​
Beta 5,000+ row flow

  1. Upload the CSV with Upload large campaign CSV.
  2. Poll Get large campaign upload status.
  3. Confirm balance with Check large campaign balance.
  4. Start calls with Make large campaign calls async.
  5. Monitor campaign state here and inspect call rows through call history.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

​
call_count
boolean
default:true

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

​
limit
integer
default:10

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

Required range: 1 <= x <= 1000
​
offset
integer
default:0

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

Required range: x >= 0

Response

List of campaigns retrieved successfully.

​
campaigns
object[]
​
pagination
object