Skip to main content
GET
Get All Campaigns
A campaign’s id is the list_id or bulk_list_id returned when its list was uploaded, so you can match rows to the campaigns you created.

Statuses

Notes

  • limit defaults to 10; page with offset.
  • total_calls is the number of valid contacts loaded from the list, not the number of calls placed. It is 0 until the list has been validated. invalidated_rows_count is the number of rows dropped as invalid.
  • Rows in insufficient_balance also carry additional_balance_required, the extra balance needed, as a decimal string.
  • For the calls inside one campaign, use call history with bulk_list_id.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Query Parameters

limit
integer
default:10

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

offset
integer
default:0

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

Response

List of campaigns retrieved successfully.

campaigns
object[]
pagination
object