List Lead

Lists leads belonging to campaigns in your company.

GET/api/v1/leads/list

Examples

Request

curl --request GET \
  --url 'https://api.vaanii.ai/api/v1/leads/list?campaign_id=d25bb4a6-bc94-4d2b-9e0d-43f9817ecff4&status_filter=new&page=1&per_page=10' \
  --header 'X-API-Key: <your_api_key>'

Response

Possible HTTP status codes for this endpoint, with a representative response body for each. Select a status to preview it.

200 OKSuccessful response

{
  "leads": [
    {
      "id": "78027694-837a-4aac-b6e3-f38b64f17bfd",
      "campaign_id": "d25bb4a6-bc94-4d2b-9e0d-43f9817ecff4",
      "first_name": "Ishaan",
      "phone_e164": "+919101997663",
      "status": "new",
      "custom_fields": {
        "loan_amount": 1218628,
        "city": "Delhi"
      },
      "calls_count": 0,
      "updated_at": "2026-09-11T23:38:44+05:30",
      "next_scheduled_call": "2026-09-12T04:56:44+05:30"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 10
}

Description

Returns a paginated list of non-deleted leads, ordered by updated_at descending. Can be filtered by campaign, status, or search text.

Query parameters (all optional)

Param	Type	Description
`campaign_id`	UUID	Restrict to one campaign.
`status_filter`	string	Filter by status (e.g. `new`, `done`).
`search`	string	Partial name or phone match.
`page`	integer	Page number, `>= 1`. Default `1`.
`per_page`	integer	`1` – `100`. Default `10`.

Errors

Status	Detail
`403`	Campaign not found (when `campaign_id` is filtered by).