Skip to main content
GET
/
api
/
v1
/
campaigns
List Campaigns
curl --request GET \
  --url https://api.ravan.ai/api/v1/campaigns/ \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "agent_id": "<string>",
      "phone_number_id": "<string>",
      "from_phone_number": "<string>",
      "status": "<string>",
      "execution_status": "<string>",
      "schedule": {
        "start": "<string>",
        "end": "<string>",
        "window_start": "<string>",
        "window_end": "<string>",
        "window_days": [
          123
        ],
        "timezone": "<string>",
        "max_concurrent": 123,
        "retry_attempts": 123,
        "retry_gap_min": 123
      },
      "contact_stats": {
        "total": 123,
        "contacted": 123,
        "successful": 123,
        "failed": 123,
        "no_answer": 123,
        "pending": 123,
        "in_progress": 123
      },
      "started_at": "<string>",
      "completed_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ravan.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Api-Key
string
required
Your Agni API key. Find it in your RavanAi.

Query Parameters

limit
integer
Number of results to return
offset
integer
Pagination offset
status
string
Filter by campaign status

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message.
data
array
Array of campaign objects.
meta
object
Pagination metadata.

Authorizations

X-Api-Key
string
header
required

Query Parameters

limit
integer

Number of results to return

offset
integer

Pagination offset

status
string

Filter by campaign status

Response

200 - application/json

Successful response

success
boolean
message
string
data
object[]
meta
object