> ## Documentation Index
> Fetch the complete documentation index at: https://kaneo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Start an import

> Import the selected source projects into the workspace as new Kaneo projects. The import runs in the background; poll getImportRun for progress. The credentials are held in memory only while the import runs; they are never stored, logged, or returned. Imported tasks do not send notifications or trigger integrations.



## OpenAPI

````yaml /openapi.json post /import/runs
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /import/runs:
    post:
      tags:
        - Import
      summary: Start an import
      description: >-
        Import the selected source projects into the workspace as new Kaneo
        projects. The import runs in the background; poll getImportRun for
        progress. The credentials are held in memory only while the import runs;
        they are never stored, logged, or returned. Imported tasks do not send
        notifications or trigger integrations.
      operationId: startImportRun
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                workspaceId:
                  type: string
                  minLength: 1
                connection:
                  $ref: '#/components/schemas/ImportConnection'
                projectIds:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 512
                  minItems: 1
                  maxItems: 50
                  description: >-
                    Source project IDs from listImportSourceProjects, imported
                    in this order.
                includeComments:
                  type: boolean
                  default: true
                  description: Import task comments too. Defaults to true.
              required:
                - workspaceId
                - connection
                - projectIds
      responses:
        '202':
          description: The import started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportRunEnvelope'
        '400':
          description: >-
            Invalid body, credentials the source rejected, a destination this
            server may not reach, or a selected project the source no longer
            lists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '402':
          description: Workspace plan has expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Missing workspace:manage_settings or project:create permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Another import is already running in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            This server is already running its maximum number of imports, or the
            API key exceeded its rate limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '502':
          description: The source could not be reached or answered with an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '503':
          description: The server is restarting and not starting new imports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ImportConnection:
      oneOf:
        - $ref: '#/components/schemas/PlankaImportConnection'
        - $ref: '#/components/schemas/PlaneImportConnection'
        - $ref: '#/components/schemas/LinearImportConnection'
        - $ref: '#/components/schemas/JiraImportConnection'
        - $ref: '#/components/schemas/TrelloImportConnection'
        - $ref: '#/components/schemas/KaneoImportConnection'
      discriminator:
        propertyName: source
        mapping:
          planka: '#/components/schemas/PlankaImportConnection'
          plane: '#/components/schemas/PlaneImportConnection'
          linear: '#/components/schemas/LinearImportConnection'
          jira: '#/components/schemas/JiraImportConnection'
          trello: '#/components/schemas/TrelloImportConnection'
          kaneo: '#/components/schemas/KaneoImportConnection'
      description: >-
        Where to import from and how to sign in. Credentials are used only for
        this request and the import it starts; they are never stored, logged, or
        returned.
    ImportRunEnvelope:
      type: object
      properties:
        run:
          $ref: '#/components/schemas/ImportRun'
      required:
        - run
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
    PlankaImportConnection:
      type: object
      properties:
        source:
          type: string
          enum:
            - planka
        url:
          type: string
          minLength: 1
          maxLength: 2048
          description: Address of the PLANKA instance.
          example: https://planka.example.com
        apiKey:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            A PLANKA API key. Send it, or username and password. Used only for
            this import and never stored or logged.
        username:
          type: string
          minLength: 1
          maxLength: 256
          description: >-
            Username or email of a PLANKA account, used with password when no
            API key is sent.
        password:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            Password of that PLANKA account. Used only for this import and never
            stored or logged.
      required:
        - source
        - url
    PlaneImportConnection:
      type: object
      properties:
        source:
          type: string
          enum:
            - plane
        url:
          type: string
          minLength: 1
          maxLength: 2048
          description: >-
            Address of the Plane instance, e.g. https://app.plane.so for Plane
            Cloud.
          example: https://planka.example.com
        apiKey:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            A Plane personal access token. Used only for this import and never
            stored or logged.
        workspaceSlug:
          type: string
          minLength: 1
          maxLength: 256
          description: >-
            Slug of the Plane workspace to read. Optional when the URL already
            names it.
      required:
        - source
        - url
        - apiKey
    LinearImportConnection:
      type: object
      properties:
        source:
          type: string
          enum:
            - linear
        apiKey:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            A Linear personal API key. Used only for this import and never
            stored or logged.
      required:
        - source
        - apiKey
    JiraImportConnection:
      type: object
      properties:
        source:
          type: string
          enum:
            - jira
        url:
          type: string
          minLength: 1
          maxLength: 2048
          description: >-
            Address of the Jira site, e.g. https://your-site.atlassian.net for
            Jira Cloud, or your own domain for Jira Data Center.
          example: https://your-site.atlassian.net
        email:
          type: string
          minLength: 1
          maxLength: 320
          description: >-
            Email of the Atlassian account the API token belongs to. Required
            for Jira Cloud; leave it out for Jira Data Center.
        apiToken:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            A Jira Cloud API token, sent with email, or a Jira Data Center
            personal access token, sent without email. Used only for this import
            and never stored or logged.
      required:
        - source
        - url
        - apiToken
    TrelloImportConnection:
      type: object
      properties:
        source:
          type: string
          enum:
            - trello
        token:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            A Trello token authorized for this Kaneo instance. Used only for
            this import and never stored or logged.
        apiKey:
          type: string
          minLength: 1
          maxLength: 256
          description: >-
            Trello API key, a public app identifier. Defaults to the server's
            TRELLO_API_KEY.
      required:
        - source
        - token
    KaneoImportConnection:
      type: object
      properties:
        source:
          type: string
          enum:
            - kaneo
        url:
          type: string
          minLength: 1
          maxLength: 2048
          description: Address of the Kaneo instance to import from.
          example: https://planka.example.com
        apiKey:
          type: string
          minLength: 1
          maxLength: 4096
          description: >-
            An API key from that Kaneo instance. Used only for this import and
            never stored or logged.
      required:
        - source
        - url
        - apiKey
    ImportRun:
      type: object
      properties:
        id:
          type: string
        workspaceId:
          type: string
        source:
          type: string
          enum:
            - planka
            - plane
            - linear
            - jira
            - trello
            - kaneo
        status:
          type: string
          enum:
            - running
            - completed
            - failed
          description: >-
            completed once every selected project was attempted, even if some
            failed; check each project's status. failed means the run itself
            stopped.
        includeComments:
          type: boolean
        message:
          type:
            - string
            - 'null'
          description: Latest progress line while the run is running.
        error:
          type:
            - string
            - 'null'
        projects:
          type: array
          items:
            $ref: '#/components/schemas/ImportRunProject'
        createdAt:
          type: string
          format: date-time
        finishedAt:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - workspaceId
        - source
        - status
        - includeComments
        - message
        - error
        - projects
        - createdAt
        - finishedAt
    ImportRunProject:
      type: object
      properties:
        sourceId:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
        projectId:
          type:
            - string
            - 'null'
          description: The Kaneo project created by the import, once completed.
        projectSlug:
          type:
            - string
            - 'null'
        counts:
          $ref: '#/components/schemas/ImportCounts'
        warnings:
          type: array
          items:
            type: string
        error:
          type:
            - string
            - 'null'
      required:
        - sourceId
        - name
        - status
        - projectId
        - projectSlug
        - counts
        - warnings
        - error
    ImportCounts:
      type: object
      properties:
        columns:
          type: integer
        tasks:
          type: integer
        labels:
          type: integer
        comments:
          type: integer
        assignees:
          type: integer
          description: Tasks that were assigned to a workspace member.
        relations:
          type: integer
      required:
        - columns
        - tasks
        - labels
        - comments
        - assignees
        - relations
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.