---
title: "List leads"
method: GET
path: "/leads"
tags: ["Leads"]
---

# List leads

`GET /leads`

## Request

- Base URL: `https://vocenya.com/api/public/v1`
- URL: `https://vocenya.com/api/public/v1/leads`
- Auth: HTTP bearer

Your leads, newest first.

## Query parameters

- `phone_number` string
- `email` string, email
- `since` string, date-time
- `until` string, date-time
- `per_page` integer
- `cursor` string, nullable

## Response `200`

Paginated set of `LeadResource`

- object
  - `data` LeadResource[], required
    - `id` integer, required
    - `livemode` boolean, required: `true` for live data, `false` for test data (created with a `vk_test_` key).
    - `name` string, nullable, required
    - `phone_number` string, nullable, required
    - `email` string, nullable, required
    - `reason` string: Why they got in touch. Not included for HIPAA-mode accounts.
    - `urgency` string, nullable, required
    - `details` object, nullable: Extra fields captured with the lead. Not included for HIPAA-mode accounts.
    - `custom_fields` object: The custom fields the AI collected, as `{key: {label, value}}`. Not included for HIPAA-mode accounts.
    - `source` 'api' | 'call' | 'chat' | 'outbound_call' | 'website', required: Where the lead came from.
    - `call_id` integer, nullable, required
    - `chat_id` integer, nullable, required
    - `outbound_call_id` integer, nullable, required
    - `created_at` string, nullable, required
  - `links` object, required
    - `first` string, nullable, required
    - `last` string, nullable, required
    - `prev` string, nullable, required
    - `next` string, nullable, required
  - `meta` object, required
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `next_cursor` string, nullable, required: The "cursor" that points to the next set of items.
    - `prev_cursor` string, nullable, required: The "cursor" that points to the previous set of items.

## Other responses

- `401`: The API key is missing, invalid, expired or revoked.
- `403`: The key does not have the `leads:read` scope.
- `422`: Validation error
- `429`: Too many requests for this key. Wait for the `Retry-After` seconds.

---

[API](https://skmtc.dev/vocenya/apis/vocenya-api.md) · [All operations](https://skmtc.dev/vocenya/apis/vocenya-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocenya/apis/vocenya-api/revisions/946913941565?raw)