---
title: "List Leads"
method: POST
path: "/lead"
tags: ["Leads"]
---

# List Leads

`POST /lead`

Get a list of Leads

## Request body

- GetLeads — Get leads
  - `trip_uuids` string[] — Trip UUIDs
  - `is_booked` boolean — Whether lead is booked or not
  - `sort_by` 'email' | 'recent_requested_at' — Field name to sort by
  - `sort_dir` 'desc' | 'asc' — Direction of sorting
  - `lead_type` string — Type of the leads
  - `before` string, date — Recent request before date
  - `after` string, date — Recent request after date
  - `page` integer — Page number
  - `per_page` 25 | 50 | 100 — Leads per page

## Response `200`

Get a list of leads

- object
  - `data` Lead[]
    - `id` integer — Lead ID
    - `trip_uuid` string — Trip UUID
    - `email` string — Lead email
    - `name` string — Lead name
    - `phone` string — Lead phone
    - `organizer_id` integer — Organizer ID
    - `is_booked` boolean — Whether lead is booked or not
    - `questions` Question[] — Lead questions
      - `content` string — Question content
      - `created_at` string, date-time — Question created at
    - `recent_requested_at` string, date-time — Recent request date
    - `lead_type` string — Type of the lead
    - `trip` Trip — Trip object
      - `title` string — Trip title
  - `pagination` Pagination — Pagination object
    - `total_count` integer — Total number of leads
    - `page` integer — Current page number where the lead is found
    - `per_page` integer — How many lead are per page (default: 25)
    - `total_pages` integer — Total number of pages
    - `has_previous` boolean — Whether the previous page is there or not
    - `has_next` boolean — Whether the next page is there or not

---

[API](https://skmtc.dev/wetravel/apis/authentication-api.md) · [All operations](https://skmtc.dev/wetravel/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wetravel/authentication-api/revisions/5c747875f084/schema)