KaiCalls Integrations API

openapi: 3.2.0
info:
  title: KaiCalls Public Integrations 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: Integrations
paths:
  /v1/integrations/nimbata:
    get:
      summary: 'Nimbata status for a business (integrations:write): the connected account…'
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      - name: action
        in: query
        schema:
          type: string
          enum:
          - status
      responses:
        '200':
          description: Status; never echoes a token
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: getV1IntegrationsNimbata
      x-operation-id-source: derived
    post:
      summary: Manage Nimbata (integrations:write).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              - action
              properties:
                business_id:
                  type: string
                action:
                  type: string
                  enum:
                  - connect
                  - link_project
                  - unlink_project
                  - set_writeback
                api_token:
                  type: string
                  description: Nimbata personal API token (connect).
                project_id:
                  type: string
                target_business_id:
                  type: string
                  description: Business to attach the project to; defaults to business_id.
                link_id:
                  type: string
                enabled:
                  type: boolean
      responses:
        '200':
          description: Done; never echoes a token
        '400':
          description: Missing input, or Nimbata refused the token or plan
        '403':
          description: Missing scope, no access, or not an admin of a business involved
        '409':
          description: Token belongs to a different Nimbata account than linked projects
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: postV1IntegrationsNimbata
      x-operation-id-source: derived
    delete:
      summary: 'Disconnect Nimbata: unlinks every project and deletes the saved token…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              properties:
                business_id:
                  type: string
      responses:
        '200':
          description: Disconnected
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: deleteV1IntegrationsNimbata
      x-operation-id-source: derived
  /v1/integrations/callrail:
    get:
      summary: 'CallRail status for a business (integrations:write): the connected account…'
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      - name: action
        in: query
        schema:
          type: string
          enum:
          - status
          - list_trackers
      - name: link_id
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Status; never echoes a key
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: getV1IntegrationsCallrail
      x-operation-id-source: derived
    post:
      summary: Manage CallRail (integrations:write).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              - action
              properties:
                business_id:
                  type: string
                action:
                  type: string
                  enum:
                  - connect
                  - link_company
                  - unlink_company
                  - route_tracker
                  - restore_tracker
                  - set_writeback
                api_key:
                  type: string
                  description: CallRail API key (connect).
                account_id:
                  type: string
                  description: CallRail account, when the key sees several.
                company_id:
                  type: string
                target_business_id:
                  type: string
                  description: Business to attach the company to; defaults to business_id.
                link_id:
                  type: string
                tracker_id:
                  type: string
                mode:
                  type: string
                  enum:
                  - kai_answers
                  - business_first
                kai_number:
                  type: string
                enabled:
                  type: boolean
      responses:
        '200':
          description: Done; never echoes a key
        '400':
          description: Missing input or CallRail refused the key
        '403':
          description: Missing scope, no access, or not an admin of a business involved
        '409':
          description: Needs a choice first (several accounts, non-basic call flow, no ring-first line)
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: postV1IntegrationsCallrail
      x-operation-id-source: derived
    delete:
      summary: 'Disconnect CallRail: removes the KaiCalls webhook from every linked company…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              properties:
                business_id:
                  type: string
      responses:
        '200':
          description: Disconnected
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: deleteV1IntegrationsCallrail
      x-operation-id-source: derived
  /v1/integrations/rentopian:
    post:
      summary: Connect Rentopian for a business with its Open API key alone…
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              - open_api_key
              properties:
                business_id:
                  type: string
                open_api_key:
                  type: string
                  description: Rentopian Open API key.
                api_key:
                  type: string
                  description: Optional website key.
                domain:
                  type: string
                  description: Website registered in Rentopian API Settings; needed with api_key.
      responses:
        '200':
          description: Connected; never echoes a key
        '400':
          description: Missing or refused key
        '403':
          description: Missing scope, no access, or not a business admin
        '503':
          description: Rentopian could not be reached to check the key
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: postV1IntegrationsRentopian
      x-operation-id-source: derived
    delete:
      summary: 'Disconnect Rentopian: deletes the saved keys and the connection, the same path…'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - business_id
              properties:
                business_id:
                  type: string
      responses:
        '200':
          description: Disconnected
        '404':
          description: Rentopian is not connected
      x-required-scopes: integrations:write
      tags:
      - Integrations
      operationId: deleteV1IntegrationsRentopian
      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.