---
title: "List the coach's leads"
method: GET
path: "/api/leads"
tags: ["Leads"]
---

# List the coach's leads

`GET /api/leads`

## Request

- Base URL: `https://api.setluca.com`
- URL: `https://api.setluca.com/api/leads`
- Auth: one of:
  - API key in cookie `luca.session_token`
  - API key in header `x-api-key`
  - HTTP bearer

Cursor-paginated, most recently active first. Narrow it with `channel`, or search names and handles with `q`. Send `nextCursor` back as `cursor` for the next page. A key on the redacted data tier gets the structured fields only, so `displayName` and `externalUserId` come back blank.

**API key scopes:** `leads:read`.

## Query parameters

- `limit` integer
- `cursor` string
- `channel` 'telegram' | 'instagram' | 'messenger' | 'whatsapp'
- `q` string

## Headers

- `Luca-API-Version` '1'

## Response `200`

ok

- LeadListResponse
  - `leads` object[], required
    - `id` string, uuid, required
    - `channel` 'telegram' | 'instagram' | 'messenger' | 'whatsapp', required
    - `displayName` string, nullable, required
    - `profilePhotoUrl` string, uri, nullable
    - `externalUserId` string, required
    - `tags` string[], required
    - `lastSeenAt` string, required
    - `createdAt` string, required
  - `nextCursor` string, nullable, required

## Other responses

- `400`: bad request
- `401`: unauthorized
- `429`: rate limited
- `500`: internal error
- `503`: service unavailable

---

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