---
title: "Get a lead"
method: GET
path: "/leads/{lead}"
tags: ["Leads"]
---

# Get a lead

`GET /leads/{lead}`

## Request

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

## Path parameters

- `lead` integer, required

## Response `200`

`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

## Other responses

- `401`: The API key is missing, invalid, expired or revoked.
- `403`: The key does not have the `leads:read` scope.
- `404`: No record with that id belongs to your account.
- `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)