GET
/
api
/
v1
/
contacts
curl "https://api.ravan.ai/api/v1/contacts/?search=john&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true, "message": "Contacts fetched successfully",
  "data": [{ "id": "019d3a2b-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "first_name": "John", "last_name": "Smith", "email": "john@example.com", "phone": "+14155550100", "company": "Acme Corp" }],
  "meta": { "total": 1, "limit": 10, "offset": 0 }
}

Authorizations

X-Api-Key
string
required
Your Agni API key.

Query Parameters

Search by name, email, or phone.
limit
integer
Maximum contacts to return.
offset
integer
Pagination offset.

Response

success
boolean
Whether the request succeeded.
message
string
Human-readable status message.
data
object[]
Array of contact records.
meta
object
Pagination metadata with total, limit, offset.
curl "https://api.ravan.ai/api/v1/contacts/?search=john&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true, "message": "Contacts fetched successfully",
  "data": [{ "id": "019d3a2b-5c6d-7e8f-9a0b-1c2d3e4f5a6b", "first_name": "John", "last_name": "Smith", "email": "john@example.com", "phone": "+14155550100", "company": "Acme Corp" }],
  "meta": { "total": 1, "limit": 10, "offset": 0 }
}

Authorizations

X-Api-Key
string
header
required

Query Parameters

Search by name, email, or phone

limit
integer

Max results

offset
integer

Pagination offset

Response

Successful response

success
boolean
message
string
data
object[]
meta
object