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

# List Leads

`GET /leads/`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/leads/`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Query parameters

- `limit` integer
- `page` integer, nullable
- `status` string, nullable
- `source` string, nullable
- `lead_type` string, nullable
- `utm_source` string, nullable
- `query` string, nullable
- `received_after` string, date-time, nullable
- `received_before` string, date-time, nullable

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- LeadPage
  - `items` LeadPublic[], required
    - `id` string, required
    - `organization_id` string, required
    - `source` string, required
    - `external_id` string, required
    - `status` 'pending' | 'synced' | 'failed', required
    - `data` object, required
    - `lead_type` string, nullable
    - `raw_payload` object, nullable
    - `received_at` string, date-time, nullable
    - `synced_at` string, date-time, nullable
    - `crm_contact_id` string, nullable
    - `sync_error` string, nullable
    - `retry_count` integer, required
  - `total` integer, required

## Other responses

- `422`: Validation Error

---

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