KaiCalls Zapier API

openapi: 3.2.0
info:
  title: KaiCalls Public Zapier 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: Zapier
paths:
  /v1/zapier/auth-test:
    get:
      summary: 'Zapier connection test: validate the API key and return the workspace identity'
      parameters:
      - name: business_id
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Auth test result
      tags:
      - Zapier
      operationId: getV1ZapierAuthTest
      x-operation-id-source: derived
  /v1/zapier/triggers/call-completed:
    get:
      summary: 'Zapier trigger: poll for completed calls (supports sample mode)'
      parameters:
      - name: business_id
        in: query
        required: false
        schema:
          type: string
      - name: sample
        in: query
        required: false
        schema:
          type: boolean
      - name: after
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Completed-call trigger payload
      x-required-scopes: calls:read
      tags:
      - Zapier
      operationId: getV1ZapierTriggersCallCompleted
      x-operation-id-source: derived
  /v1/zapier/triggers/lead-created:
    get:
      summary: 'Zapier trigger: poll for newly created leads (supports sample mode)'
      parameters:
      - name: business_id
        in: query
        required: false
        schema:
          type: string
      - name: sample
        in: query
        required: false
        schema:
          type: boolean
      - name: after
        in: query
        required: false
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Lead-created trigger payload
      x-required-scopes: leads:read
      tags:
      - Zapier
      operationId: getV1ZapierTriggersLeadCreated
      x-operation-id-source: derived
  /v1/zapier/triggers/lead-score-updated:
    get:
      summary: 'Zapier trigger: poll for updated lead scores (supports sample mode)'
      responses:
        '200':
          description: Lead-score-updated trigger payload
      x-required-scopes: leads:read
      tags:
      - Zapier
      operationId: getV1ZapierTriggersLeadScoreUpdated
      x-operation-id-source: derived
  /v1/zapier/triggers/appointment-booked:
    get:
      summary: 'Zapier trigger: poll for newly booked appointments (supports sample mode)'
      responses:
        '200':
          description: Appointment-booked trigger payload
      x-required-scopes: appointments:read
      tags:
      - Zapier
      operationId: getV1ZapierTriggersAppointmentBooked
      x-operation-id-source: derived
  /v1/zapier/actions/create-lead:
    post:
      summary: 'Zapier action: create a lead in a workspace (leads:write)'
      responses:
        '200':
          description: Created lead
      x-required-scopes: leads:write
      tags:
      - Zapier
      operationId: postV1ZapierActionsCreateLead
      x-operation-id-source: derived
  /v1/zapier/actions/add-note:
    post:
      summary: 'Zapier action: append a note to an existing lead (leads:write)'
      responses:
        '200':
          description: Updated lead note
      x-required-scopes: leads:write
      tags:
      - Zapier
      operationId: postV1ZapierActionsAddNote
      x-operation-id-source: derived
  /v1/zapier/actions/request-follow-up-call:
    post:
      summary: 'Zapier action: request a follow-up call (calls:write)'
      responses:
        '200':
          description: Queued follow-up request
      x-required-scopes: calls:write
      tags:
      - Zapier
      operationId: postV1ZapierActionsRequestFollowUpCall
      x-operation-id-source: derived
  /v1/zapier/actions/make-outbound-call:
    post:
      summary: 'Zapier action: queue a single outbound call through the communication-run…'
      responses:
        '201':
          description: Outbound call queued
      x-required-scopes: calls:write
      tags:
      - Zapier
      operationId: postV1ZapierActionsMakeOutboundCall
      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.