Kairon

Kairon Company Lists API

The company-lists API from Kairon — 22 operation(s) for company-lists.

GitHub OpenAPI

Operations 28

POST /api/company-lists/{listId}/qualification-runs Company qualification runs controller create #
GET /api/company-lists/{listId}/qualification-runs Company qualification runs controller recent #
GET /api/company-lists/{listId}/qualification-runs/latest Company qualification runs controller newest #
GET /api/company-lists/{listId}/qualification-runs/{runId}/items Company qualification runs controller items #
GET /api/company-lists/{listId}/qualification-runs/{runId}/breakdown Company qualification runs controller breakdown #
GET /api/company-lists/{listId}/qualification-runs/{runId} Company qualification runs controller get #
POST /api/company-lists/{listId}/qualification-runs/{runId}/rerun Company qualification runs controller rerun #
POST /api/company-lists/{listId}/qualification-runs/{runId}/cancel Company qualification runs controller cancel #
POST /api/company-lists Company lists controller create #
GET /api/company-lists Company lists controller list #
PUT /api/company-lists/{id}/columns Company lists controller set columns #
PUT /api/company-lists/{id}/members/{companyId}/values Company lists controller set member values #
GET /api/company-lists/suggest Company lists controller suggest #
GET /api/company-lists/{id} Company lists controller get #
PATCH /api/company-lists/{id} Company lists controller rename #
DELETE /api/company-lists/{id} Company lists controller delete #
PUT /api/company-lists/{id}/archived Company lists controller set archived #
GET /api/company-lists/{id}/summary Company lists controller summary #
GET /api/company-lists/{id}/members Company lists controller list members #
POST /api/company-lists/{id}/members Company lists controller add members #
DELETE /api/company-lists/{id}/members Company lists controller remove members #
GET /api/company-lists/{id}/members/export Company lists controller export members #
GET /api/company-lists/{id}/members/keys Company lists controller member keys #
GET /api/company-lists/{id}/members/by-keys Company lists controller members by keys #
POST /api/company-lists/{id}/members/remove Company lists controller remove members by keys #
POST /api/company-lists/{id}/members/restore Company lists controller restore members by keys #
POST /api/company-lists/{id}/load-companies Company lists controller load companies #
PUT /api/company-lists/{id}/reconcile Company lists controller reconcile #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/heykairon-com/openapi/heykairon-com-company-lists-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-campaign-draft-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-agent-campaign-chat-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-agent-icp-chat-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-create-icp-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-update-icp-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/heykairon-com/json-schema/heykairon-com-set-source-body-dto-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/heykairon-com:heykairon-com-company-lists-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

heykairon-com-company-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Kairon Company Lists API
  description: B2B agentic go-to-market platform
  version: 0.0.0
  contact: {}
servers: []
security:
- api-key: []
tags:
- name: company-lists
paths:
  /api/company-lists/{listId}/qualification-runs:
    post:
      operationId: CompanyQualificationRunsController_create
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QualificationRunCreateDto'
      responses:
        '201':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller create
      x-summary-source: derived
    get:
      operationId: CompanyQualificationRunsController_recent
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller recent
      x-summary-source: derived
  /api/company-lists/{listId}/qualification-runs/latest:
    get:
      operationId: CompanyQualificationRunsController_newest
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller newest
      x-summary-source: derived
  /api/company-lists/{listId}/qualification-runs/{runId}/items:
    get:
      operationId: CompanyQualificationRunsController_items
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      - name: runId
        required: true
        in: path
        schema:
          type: string
      - name: limit
        required: false
        in: query
        x-nestjs_zod-uses-3-point-1-syntax: true
        schema:
          maximum: 200
          exclusiveMinimum: 0
          default: 50
          type: integer
      - name: offset
        required: false
        in: query
        x-nestjs_zod-uses-3-point-1-syntax: true
        schema:
          minimum: 0
          maximum: 9007199254740991
          default: 0
          type: integer
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller items
      x-summary-source: derived
  /api/company-lists/{listId}/qualification-runs/{runId}/breakdown:
    get:
      operationId: CompanyQualificationRunsController_breakdown
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      - name: runId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller breakdown
      x-summary-source: derived
  /api/company-lists/{listId}/qualification-runs/{runId}:
    get:
      operationId: CompanyQualificationRunsController_get
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      - name: runId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller get
      x-summary-source: derived
  /api/company-lists/{listId}/qualification-runs/{runId}/rerun:
    post:
      operationId: CompanyQualificationRunsController_rerun
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      - name: runId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QualificationRunRerunDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller rerun
      x-summary-source: derived
  /api/company-lists/{listId}/qualification-runs/{runId}/cancel:
    post:
      operationId: CompanyQualificationRunsController_cancel
      parameters:
      - name: listId
        required: true
        in: path
        schema:
          type: string
      - name: runId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company qualification runs controller cancel
      x-summary-source: derived
  /api/company-lists:
    post:
      operationId: CompanyListsController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListCreateDto'
      responses:
        '201':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller create
      x-summary-source: derived
    get:
      operationId: CompanyListsController_list
      parameters:
      - name: q
        required: false
        in: query
        schema:
          minLength: 1
          maxLength: 200
          type: string
      - name: cursor
        required: false
        in: query
        schema:
          maxLength: 65536
          type: string
      - name: limit
        required: false
        in: query
        schema:
          minimum: 1
          maximum: 100
          default: 25
          type: integer
      - name: status
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller list
      x-summary-source: derived
  /api/company-lists/{id}/columns:
    put:
      operationId: CompanyListsController_setColumns
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListColumnsDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller set columns
      x-summary-source: derived
  /api/company-lists/{id}/members/{companyId}/values:
    put:
      operationId: CompanyListsController_setMemberValues
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: companyId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListColumnValuesDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller set member values
      x-summary-source: derived
  /api/company-lists/suggest:
    get:
      operationId: CompanyListsController_suggest
      parameters:
      - name: q
        required: false
        in: query
        schema:
          maxLength: 200
          type: string
      - name: limit
        required: false
        in: query
        schema:
          minimum: 1
          maximum: 25
          default: 8
          type: integer
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller suggest
      x-summary-source: derived
  /api/company-lists/{id}:
    get:
      operationId: CompanyListsController_get
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller get
      x-summary-source: derived
    patch:
      operationId: CompanyListsController_rename
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListUpdateDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller rename
      x-summary-source: derived
    delete:
      operationId: CompanyListsController_delete
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller delete
      x-summary-source: derived
  /api/company-lists/{id}/archived:
    put:
      operationId: CompanyListsController_setArchived
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListArchiveDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller set archived
      x-summary-source: derived
  /api/company-lists/{id}/summary:
    get:
      operationId: CompanyListsController_summary
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller summary
      x-summary-source: derived
  /api/company-lists/{id}/members:
    get:
      operationId: CompanyListsController_listMembers
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: cursor
        required: false
        in: query
        schema:
          maxLength: 65536
          type: string
      - name: limit
        required: false
        in: query
        schema:
          minimum: 1
          maximum: 100
          default: 25
          type: integer
      - name: q
        required: false
        in: query
        schema:
          minLength: 1
          maxLength: 200
          type: string
      - name: sort
        required: false
        in: query
        schema:
          type: string
          enum:
          - company
          - industry
          - qualification
          - owner
          - added
      - name: direction
        required: false
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: qualificationStatus
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: ownerId
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: tagId
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: addedAfter
        required: false
        in: query
        schema:
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          type: string
      - name: addedBefore
        required: false
        in: query
        schema:
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          type: string
      - name: hydrated
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: boolean
          - type: string
            enum:
            - 'true'
            - 'false'
      - name: column
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items: {}
      - name: employeeMin
        required: false
        in: query
        schema:
          minimum: 0
          maximum: 9007199254740991
          type: integer
      - name: employeeMax
        required: false
        in: query
        schema:
          minimum: 0
          maximum: 9007199254740991
          type: integer
      - name: industry
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: hqCountry
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller list members
      x-summary-source: derived
    post:
      operationId: CompanyListsController_addMembers
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListAddMembersDto'
      responses:
        '201':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller add members
      x-summary-source: derived
    delete:
      operationId: CompanyListsController_removeMembers
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListRemoveMembersDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller remove members
      x-summary-source: derived
  /api/company-lists/{id}/members/export:
    get:
      operationId: CompanyListsController_exportMembers
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: q
        required: false
        in: query
        schema:
          minLength: 1
          maxLength: 200
          type: string
      - name: sort
        required: false
        in: query
        schema:
          type: string
          enum:
          - company
          - industry
          - qualification
          - owner
          - added
      - name: direction
        required: false
        in: query
        schema:
          type: string
          enum:
          - asc
          - desc
      - name: qualificationStatus
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: ownerId
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: tagId
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: addedAfter
        required: false
        in: query
        schema:
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          type: string
      - name: addedBefore
        required: false
        in: query
        schema:
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          type: string
      - name: hydrated
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: boolean
          - type: string
            enum:
            - 'true'
            - 'false'
      - name: column
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items: {}
      - name: employeeMin
        required: false
        in: query
        schema:
          minimum: 0
          maximum: 9007199254740991
          type: integer
      - name: employeeMax
        required: false
        in: query
        schema:
          minimum: 0
          maximum: 9007199254740991
          type: integer
      - name: industry
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: hqCountry
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller export members
      x-summary-source: derived
  /api/company-lists/{id}/members/keys:
    get:
      operationId: CompanyListsController_memberKeys
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: q
        required: false
        in: query
        schema:
          minLength: 1
          maxLength: 200
          type: string
      - name: qualificationStatus
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: ownerId
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: tagId
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: addedAfter
        required: false
        in: query
        schema:
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          type: string
      - name: addedBefore
        required: false
        in: query
        schema:
          format: date-time
          pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          type: string
      - name: hydrated
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: boolean
          - type: string
            enum:
            - 'true'
            - 'false'
      - name: column
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items: {}
      - name: employeeMin
        required: false
        in: query
        schema:
          minimum: 0
          maximum: 9007199254740991
          type: integer
      - name: employeeMax
        required: false
        in: query
        schema:
          minimum: 0
          maximum: 9007199254740991
          type: integer
      - name: industry
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: hqCountry
        required: false
        in: query
        x-nestjs_zod-empty-type: true
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller member keys
      x-summary-source: derived
  /api/company-lists/{id}/members/by-keys:
    get:
      operationId: CompanyListsController_membersByKeys
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: keys
        required: false
        in: query
        schema:
          maxItems: 100
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 2048
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller members by keys
      x-summary-source: derived
  /api/company-lists/{id}/members/remove:
    post:
      operationId: CompanyListsController_removeMembersByKeys
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListMemberKeysActionDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller remove members by keys
      x-summary-source: derived
  /api/company-lists/{id}/members/restore:
    post:
      operationId: CompanyListsController_restoreMembersByKeys
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListMemberKeysActionDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller restore members by keys
      x-summary-source: derived
  /api/company-lists/{id}/load-companies:
    post:
      operationId: CompanyListsController_loadCompanies
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller load companies
      x-summary-source: derived
  /api/company-lists/{id}/reconcile:
    put:
      operationId: CompanyListsController_reconcile
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyListReconcileDto'
      responses:
        '200':
          description: ''
      tags:
      - company-lists
      summary: Company lists controller reconcile
      x-summary-source: derived
components:
  schemas:
    CompanyListArchiveDto:
      type: object
      properties:
        archived:
          type: boolean
          description: true archives the list; false restores it.
      required:
      - archived
    QualificationRunCreateDto:
      type: object
      properties:
        icpId:
          type: string
          minLength: 1
        subjectIds:
          minItems: 1
          type: array
          items:
            type: string
            minLength: 1
        ignoreIcpMismatch:
          default: false
          type: boolean
      required:
      - icpId
      - subjectIds
    CompanyListReconcileDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
        addKeys:
          maxItems: 2500
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 2048
        removeKeys:
          maxItems: 2500
          type: array
          items:
            type: string
            minLength: 1
      required:
      - name
      - addKeys
      - removeKeys
    CompanyListMemberKeysActionDto:
      type: object
      properties:
        keys:
          minItems: 1
          maxItems: 10000
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 2048
      required:
      - keys
    CompanyListRemoveMembersDto:
      type: object
      properties:
        companyIds:
          minItems: 1
          maxItems: 500
          type: array
          items:
            type: string
            minLength: 1
      required:
      - companyIds
    CompanyListColumnValuesDto:
      type: object
      properties:
        values:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: string
            maxLength: 20000
          x-nestjs_zod-uses-3-point-1-syntax: true
          x-nestjs_zod-self-required: true
      required:
      - values
    QualificationRunRerunDto:
      type: object
      properties:
        ignoreIcpMismatch:
          default: false
          type: boolean
    CompanyListColumnsDto:
      type: object
      properties:
        columns:
          maxItems: 100
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                minLength: 1
                maxLength: 40
                description: The column's name, as it appears on the list.
              renameFrom:
                description: The column this entry RENAMES. Carry it and every member's values travel to the new name; omit it and you have deleted one column and added an empty one.
                type: string
                minLength: 1
                maxLength: 40
            required:
            - name
      required:
      - columns
    CompanyListUpdateDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
      required:
      - name
    CompanyListCreateDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
      required:
      - name
    CompanyListAddMembersDto:
      type: object
      properties:
        items:
          minItems: 1
          maxItems: 500
          type: array
          items:
            anyOf:
            - type: object
              properties:
                companyId:
                  type: string
                  minLength: 1
              required:
              - companyId
            - type: object
              properties:
                url:
                  type: string
                  minLength: 1
                  maxLength: 2048
              required:
              - url
            - type: object
              properties:
                snapshot:
                  type: object
                  properties:
                    providerId:
                      type: string
                      minLength: 1
                    name:
                      type: string
                    publicIdentifier:
                      type: string
                    description:
                      type: string
                    profileUrl:
                      type: string
                    website:
                      type: string
                    industries:
                      type: array
                      items:
                        type: string
                    employeeCount:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    followerCount:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                    hqCity:
                      type: string
                    hqCountry:
                      type: string
                    logoUrl:
                      type: string
                  required:
                  - providerId
              required:
              - snapshot
      required:
      - items
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: 'A Kairon API key (Settings → Integrations → API access), sent as `x-api-key`. NOT an `Authorization: Bearer` token — that header belongs to the separate /mcp door and is ignored here.'
    session:
      type: apiKey
      in: cookie
      name: better-auth.session_token