> ## 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.

# Get task by ticket ID

> Get a single task by its project key and number, such as KAN-12. A match in an active project takes precedence, then the most recently archived project. If the ticket ID still matches multiple accessible tasks, narrow the lookup to a workspace with workspaceId or workspaceSlug, or to a single project with projectId.



## OpenAPI

````yaml /openapi.json get /task/by-ticket-id/{ticketId}
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:
  /task/by-ticket-id/{ticketId}:
    get:
      tags:
        - Tasks
      summary: Get task by ticket ID
      description: >-
        Get a single task by its project key and number, such as KAN-12. A match
        in an active project takes precedence, then the most recently archived
        project. If the ticket ID still matches multiple accessible tasks,
        narrow the lookup to a workspace with workspaceId or workspaceSlug, or
        to a single project with projectId.
      operationId: getTaskByTicketId
      parameters:
        - schema:
            type: string
            maxLength: 128
            description: Project key and task number, e.g. KAN-12.
          required: true
          description: Project key and task number, e.g. KAN-12.
          name: ticketId
          in: path
        - schema:
            type: string
            minLength: 1
            description: Select a workspace if the ticket ID exists in more than one.
          required: false
          description: Select a workspace if the ticket ID exists in more than one.
          name: workspaceId
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            description: Select a workspace by its slug instead of its ID.
          required: false
          description: Select a workspace by its slug instead of its ID.
          name: workspaceSlug
          in: query
        - schema:
            type: string
            minLength: 1
            description: Select a project if the ticket ID exists more than once.
          required: false
          description: Select a project if the ticket ID exists more than once.
          name: projectId
          in: query
      responses:
        '200':
          description: Task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskByTicketId'
        '400':
          description: Invalid ticket ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No accessible task has this ticket ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: Ticket ID matches multiple accessible tasks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    TaskByTicketId:
      allOf:
        - $ref: '#/components/schemas/TaskWithAssignee'
        - type: object
          properties:
            workspaceId:
              type: string
              description: The workspace that owns the task's project.
          required:
            - workspaceId
    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
    TaskWithAssignee:
      allOf:
        - $ref: '#/components/schemas/Task'
        - type: object
          properties:
            workspaceId:
              type: string
              description: >-
                The workspace currently owning the task's project. Included in
                the detail view; omitted from the compact board view.
            columnId:
              type:
                - string
                - 'null'
              description: >-
                The referenced workflow column; null for virtual statuses and
                legacy tasks without a column reference.
            subtaskCounts:
              type: object
              properties:
                completed:
                  type: number
                total:
                  type: number
              required:
                - completed
                - total
            parentSubtaskCounts:
              type: array
              items:
                type: object
                properties:
                  taskId:
                    type: string
                  completed:
                    type: number
                  total:
                    type: number
                required:
                  - taskId
                  - completed
                  - total
            assigneeName:
              type:
                - string
                - 'null'
            assigneeId:
              type:
                - string
                - 'null'
          required:
            - columnId
            - assigneeName
            - assigneeId
    Task:
      type: object
      properties:
        id:
          type: string
        projectId:
          type: string
        position:
          type:
            - number
            - 'null'
          description: Order within its column, ascending.
        number:
          type:
            - number
            - 'null'
          description: Per-project counter shown as {projectSlug}-{number}.
        userId:
          type:
            - string
            - 'null'
          description: The assignee, if any.
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        descriptionDeferred:
          type: boolean
          description: >-
            True when the list omits a large description; load the task detail
            or description pages to read it. Do not replace stored text with
            this null summary.
        status:
          type: string
          description: The slug of the column the task sits in.
        priority:
          type: string
          description: 'One of: no-priority, low, medium, high, urgent.'
        startDate:
          type:
            - string
            - 'null'
          format: date-time
        dueDate:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        customFields:
          type: array
          items:
            type: object
            properties:
              fieldId:
                type: string
              value:
                type: string
            required:
              - fieldId
              - value
      required:
        - id
        - projectId
        - position
        - number
        - userId
        - title
        - description
        - status
        - priority
        - startDate
        - dueDate
        - createdAt
  responses:
    ApiKeyRateLimited:
      description: >-
        The API key exceeded its rate limit or usage quota. Wait the number of
        seconds in Retry-After before retrying. The X-RateLimit headers are sent
        only when the rate limit was hit.
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying. Omitted when an exhausted usage
            quota never refills.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests the API key may make per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  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.