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

# List leads (requests)

`GET /leads`

## Request

- Base URL: `https://joinways.app/api/v1`
- URL: `https://joinways.app/api/v1/leads`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://joinways.app/oauth/authorize`, token URL `https://joinways.app/api/oauth/token`, scopes: `mcp.read`)

Inbound requests of the workspace, newest first. Archived requests (deleted, or merged into another) are left out by default. A lead locked by the Free plan keeps its name, company, dates, headcount, venue, source and status; its contact and content fields are `null`. **Role permission:** `leads.manage` (like the Inbox page).

## Query parameters

- `page` integer
- `per_page` integer
- `status` LeadStatus[]
- `source` string[]
- `archived` 'exclude' | 'only' | 'all'
- `is_read` boolean
- `q` string

## Response `200`

Page of leads.

- object: Envelope wrapping a page of results.
  - `data` Lead[], required: The page of results (item type depends on the endpoint).
    - `id` string, uuid
    - `status` 'pending' | 'validated' | 'rejected' | 'needs_info': `pending` = to process, `validated` = accepted (it has an event), `rejected` = declined, `needs_info` = waiting for information from the client.
    - `client_name` string, nullable
    - `client_email` string, nullable
    - `client_phone` string, nullable
    - `company` string, nullable
    - `event_type` string, nullable
    - `venue_name` string, nullable: Venue named in the request.
    - `venue_city` string, nullable
    - `location_id` string, uuid, nullable: The workspace venue the request is for.
    - `date_event` string, date, nullable
    - `date_event_end` string, date, nullable
    - `start_time` string, nullable
    - `end_time` string, nullable
    - `participants_min` integer, nullable
    - `participants_max` integer, nullable
    - `participants_fixed` integer, nullable
    - `budget_estimated` number, nullable
    - `budget_flexible` boolean, nullable
    - `source` string, nullable: Origin label (a platform name, `api`, `zapier`…).
    - `source_type` 'email' | 'instagram' | 'whatsapp' | 'form' | 'linkedin' | 'facebook' | 'website' | 'referral' | 'manual' | 'aircall'
    - `platform_link` string, nullable: Link of the request on the booking platform.
    - `inquiry_key` string, nullable: Identity of the request (`<platform>:<inquiry id>` or `<platform>:link:<canonical link>`). Same key = same request (siblings across venues).
    - `ai_score` number, nullable
    - `is_read` boolean
    - `is_platform` boolean
    - `is_locked` boolean: Locked by the Free plan monthly allowance (content sealed).
    - `archived_at` string, date-time, nullable: Deleted (soft) or merged into another lead.
    - `event_id` string, uuid, nullable: Event the request is on (converted or linked).
    - `requested_space_ids` string[]: Spaces (rooms) of `location_id` the request asks for.
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `validated_at` string, date-time, nullable
    - `rejected_at` string, date-time, nullable
    - `rejection_reason` 'date_unavailable' | 'capacity' | 'budget' | 'not_a_fit' | 'other': Why the venue declined the request (optional). Only set on a `rejected` lead; cleared as soon as the status changes.
    - `info_requested_at` string, date-time, nullable
    - `client_replied_at` string, date-time, nullable
  - `pagination` object, required
    - `page` integer, required: Current 1-based page.
    - `per_page` integer, required: Items per page.
    - `total` integer, nullable, required: Total matching items across all pages (`null` only on a page past the last one, when unknown).
    - `total_pages` integer, nullable, required

## Other responses

- `401`: Missing, invalid, expired or revoked bearer token (`unauthorized`).
- `403`: `forbidden`: the token lacks the scope, its owner's role lacks the permission named by the operation, or the workspace has neither the Pro plan nor a trial (`details.reason` `plan_not_eligible`).
- `429`: Too many requests (`rate_limited`). `details.reason`: `per-ip`, `per-account-minute`, `per-account-day`, or `email_rate_limited` (email budget). Always carries `Retry-After`: wait that many seconds.

---

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