Skip to main content
GET
/
api
/
v1
/
contacts
/
List Contacts
curl --request GET \
  --url https://api.ravan.ai/api/v1/contacts/ \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "metadata": {},
      "created_at": "<string>",
      "updated_at": "<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.

Query Parameters

A search string used to filter matching records by supported text fields.
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 contact objects.
meta
object
Pagination metadata.

Authorizations

X-Api-Key
string
header
required

Query Parameters

Search term

limit
integer

Number of results

offset
integer

Pagination offset

Response

200 - application/json

Successful response

success
boolean
message
string
data
object[]
meta
object