Skip to main content
GET
/
api
/
v1
/
campaigns
/
{id}
/
contacts
List Campaign Contacts
curl --request GET \
  --url https://api.ravan.ai/api/v1/campaigns/{id}/contacts \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "contact_id": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "status": "<string>",
      "attempt_count": 123,
      "last_attempted_at": "<string>",
      "next_retry_at": "<string>",
      "call_duration_sec": 123,
      "error_message": "<string>",
      "call_session_id": "<string>",
      "tags": [
        "<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.

Path Parameters

id
string
required
Campaign ID

Query Parameters

limit
integer
Max results per page
offset
integer
Pagination offset

Response

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

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Campaign ID

Response

200 - application/json

Successful response

success
boolean
message
string
data
object[]
meta
object