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>",
      "organizationId": "<string>",
      "name": "<string>",
      "agentId": "<string>",
      "phoneNumberId": "<string>",
      "fromPhoneNumber": "<string>",
      "status": "<string>",
      "executionStatus": "<string>",
      "schedule": {
        "start": "<string>",
        "end": "<string>",
        "windowStart": "<string>",
        "windowEnd": "<string>",
        "windowDays": [
          {}
        ],
        "timezone": "<string>",
        "maxConcurrent": 123,
        "retryAttempts": 123,
        "retryGapMin": 123
      },
      "contactStats": {
        "total": 123,
        "contacted": 123,
        "successful": 123,
        "failed": 123,
        "noAnswer": 123,
        "pending": 123,
        "inProgress": 123
      },
      "startedAt": "<string>",
      "completedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}
Actual endpoint: GET https://api.ravan.ai/api/v1/campaigns/ (note the trailing slash)

Authorizations

X-Api-Key
string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

Query Parameters

limit
integer
The maximum number of records to return. Use this with offset or pagination fields to page through results.
offset
integer
The number of records to skip before returning results. Use this with limit for pagination.
status
string
Filters or sets the current status of the resource. Use one of the status values supported by the endpoint.

Response

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