KaiCalls Appointments API

openapi: 3.2.0
info:
  title: KaiCalls Public Appointments 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: Appointments
paths:
  /v1/appointments/availability:
    get:
      summary: Check calendar availability for a workspace on a given date (appointments:read).
      parameters:
      - name: business_id
        in: query
        required: false
        schema:
          type: string
        description: Required when the API key has access to more than one business.
      - name: date
        in: query
        required: true
        schema:
          type: string
          format: date
      - name: duration_minutes
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 30
      responses:
        '200':
          description: Availability decision (success/unavailable)
        '400':
          description: Missing/invalid params or business disambiguation needed
        '403':
          description: API key lacks access to the business or scope
        '429':
          description: Rate limited
        '502':
          description: Calendar provider error (hard_failure)
      x-required-scopes:
        anyOf:
        - appointments:read
        - appointments:write
      tags:
      - Appointments
      operationId: getV1AppointmentsAvailability
      x-operation-id-source: derived
  /v1/appointments/book:
    post:
      summary: Book an appointment on a workspace calendar (appointments:write).
      parameters:
      - name: Idempotency-Key
        in: header
        required: true
        schema:
          type: string
          minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - start_time
              - attendee_email
              - attendee_name
              properties:
                business_id:
                  type: string
                  description: Required when the API key has access to more than one business.
                start_time:
                  type: string
                  format: date-time
                attendee_email:
                  type: string
                  format: email
                attendee_name:
                  type: string
                attendee_phone:
                  type: string
                title:
                  type: string
                description:
                  type: string
                duration_minutes:
                  type: integer
                  minimum: 1
                  default: 30
      responses:
        '200':
          description: Idempotent replay of a prior outcome for this key.
        '201':
          description: Booked — decision success, includes a durable booking_id.
        '202':
          description: queued — provider accepted the request but no durable id could be verified.
        '400':
          description: needs_clarification — missing/invalid input, no attempt made.
        '403':
          description: API key lacks access to the business or scope
        '409':
          description: unavailable — the requested slot is taken.
        '429':
          description: Rate limited
        '502':
          description: hard_failure — provider/config error.
        '503':
          description: retryable_delay — provider timed out, safe to retry.
      x-required-scopes: appointments:write
      tags:
      - Appointments
      operationId: postV1AppointmentsBook
      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.