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
  }
}

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 resource in the path. Use the ID returned by the related create or list endpoint.

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.

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