Leads

List leads (requests)

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).

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)

Query parameters

pageinteger

1-based page number.

per_pageinteger

Items per page.

statusLeadStatus[]

One or more statuses (repeat the parameter or separate with commas).

[
  "pending"
]
sourcestring[]

One or more source values (repeat the parameter or separate with commas).

archived'exclude' | 'only' | 'all'

exclude (default), only or all.

is_readboolean
qstring

Case-insensitive match on client name, company or email (unlocked leads only).

Response

Page of leads.

Example response

{
  "data": [
    {
      "status": "pending",
      "client_name": "Jane Doe",
      "company": "Acme",
      "event_type": "seminar",
      "start_time": "19:00",
      "inquiry_key": "kactus:184522",
      "rejection_reason": "date_unavailable"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 1234,
    "total_pages": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.