Skip to main content
GET
/
api
/
v1
/
campaigns
/
{id}
Get Campaign
curl --request GET \
  --url https://api.ravan.ai/api/v1/campaigns/{id} \
  --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": [
        123
      ],
      "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>",
    "outboundMaxConcurrent": 123,
    "outboundMaxCps": 123
  }
}
Actual endpoint: GET https://api.ravan.ai/api/v1/campaigns/{id}

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.

Path Parameters

id
string
required
The unique ID of the campaign. Use the id returned by the List or Create Campaign endpoint.

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message. Example: Campaign fetched successfully
data
object
Campaign object.