KaiCalls Leads API

openapi: 3.2.0
info:
  title: KaiCalls Public Leads API
  version: '2026-06-05'
  description: Machine-readable surface for KaiCalls external developers and client agents.
servers:
- url: https://www.kaicalls.com/api
security:
- bearerAuth: []
tags:
- name: Leads
paths:
  /v1/leads:
    get:
      summary: List business-scoped leads or retrieve one lead by id
      parameters:
      - name: id
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: source
        in: query
        required: false
        schema:
          type: string
      - name: agent_id
        in: query
        required: false
        schema:
          type: string
      - name: phone
        in: query
        required: false
        schema:
          type: string
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: created_after
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: created_before
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: updated_after
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: updated_before
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: after
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: score_gte
        in: query
        required: false
        schema:
          type: number
      - name: score_lte
        in: query
        required: false
        schema:
          type: number
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 50
      responses:
        '200':
          description: Lead list or lead object
      x-required-scopes: leads:read
      tags:
      - Leads
      operationId: getV1Leads
      x-operation-id-source: derived
    post:
      summary: Create or import a lead in a workspace
      description: 'Creates a lead (leads:write). For an imported walk-up or in-person customer, the integration may pass through a verified SMS opt-in by sending phone, sms_consent: true, and consent_language containing the exact disclosure the customer accepted. smsConsent, sms_opt_in, and text_consent are accepted aliases; consent: true asserts both SMS and voice consent. KaiCalls stores the disclosure and import source as consent provenance. Do not set an opt-in field unless the source system has verified the customer accepted that disclosure. A phone number alone remains cold and SMS is blocked, except for businesses explicitly configured for documented web-form implied consent. The 201 response includes consent ({ recorded, basis, channel }) whenever phone is supplied; send a portal invite only when consent.recorded is true.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              properties:
                business_id:
                  type: string
                  format: uuid
                name:
                  type: string
                email:
                  type: string
                phone:
                  type: string
                  description: E.164 preferred; normalized on write.
                source:
                  type: string
                sms_consent:
                  type: boolean
                  description: Attests that the source system verified this customer explicitly opted in to SMS. For imported walk-up clients, send true with consent_language. Never set this merely because a phone number is present.
                consent_language:
                  type: string
                  description: Exact SMS consent disclosure accepted by the customer. Stored with the capture source as proof/provenance.
      responses:
        '201':
          description: Lead created (includes a consent object when a phone was supplied).
        '400':
          description: Malformed request (missing/invalid field).
        '403':
          description: Missing leads:write scope, or business_id outside the key.
      x-required-scopes: leads:write
      tags:
      - Leads
      operationId: postV1Leads
      x-operation-id-source: derived
    patch:
      summary: Update a lead (status, fields) by id
      x-required-scopes: leads:write
      tags:
      - Leads
      operationId: patchV1Leads
      x-operation-id-source: derived
  /v1/leads/audit:
    get:
      summary: 'Return a lead-pipeline audit: new leads, follow-up activity, stalled leads, and…'
      parameters:
      - name: window_hours
        in: query
        required: false
        schema:
          type: integer
      - name: stalled_days
        in: query
        required: false
        schema:
          type: integer
      - name: hot_score
        in: query
        required: false
        schema:
          type: number
      - name: as_of
        in: query
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Lead audit summary
      x-required-scopes: leads:read
      tags:
      - Leads
      operationId: getV1LeadsAudit
      x-operation-id-source: derived
  /v1/leads/context:
    get:
      summary: 'Return the full drafting context for one lead (leads:read): the lead row, its…'
      parameters:
      - name: lead_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Lead drafting context
        '400':
          description: lead_id missing
        '404':
          description: Lead not found in an accessible business
      x-required-scopes: leads:read
      tags:
      - Leads
      operationId: getV1LeadsContext
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'KaiCalls API key. Per-operation scope requirements are published on each operation as `x-required-scopes` — a scope string, or a nested `{ allOf: [...] }` / `{ anyOf: [...] }` expression. An operation with no `x-required-scopes` requires a valid key but no particular scope.'
      x-scopes:
      - workspaces:read
      - workspaces:write
      - numbers:read
      - numbers:write
      - agents:read
      - agents:write
      - communication-runs:read
      - communication-runs:write
      - calls:read
      - calls:write
      - sms:read
      - sms:write
      - webhooks:read
      - webhooks:write
      - events:read
      - events:replay
      - lifecycle:write
      - leads:read
      - leads:write
      - emails:read
      - emails:write
      - sdr:read
      - sdr:write
      - evals:read
      - evals:write
      - appointments:read
      - appointments:write
      - knowledge:read
      - knowledge:write
      - products:read
      - products:write
      - integrations:write
      - approvals:write
      - concierge:write
      - billing:read
      - billing:write
      - call_evidence:read
      - call_evidence:write
      - support:write
    sessionAuth:
      type: apiKey
      in: cookie
      name: sb-access-token
      description: Authenticated dashboard session cookie. Used by first-party flows that mint or manage API keys.