Tasks

Get task by ticket ID

Changed on

Get a single task by its project key and number, such as KAN-12. Only tasks with current task:read permission and API key scope are considered. 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.

get/task/by-ticket-id/{ticketId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/task/by-ticket-id/{ticketId}
  • Auth
    HTTP bearer

Path parameters

ticketIdstring required

Project key and task number, e.g. KAN-12.

Query parameters

workspaceIdstring

Select a workspace if the ticket ID exists in more than one.

workspaceSlugstring

Select a workspace by its slug instead of its ID.

projectIdstring

Select a project if the ticket ID exists more than once.

Response

Task details

idstring required
projectIdstring required
positionnumber nullable required

Order within its column, ascending.

numbernumber nullable required

Per-project counter shown as {projectSlug}-{number}.

userIdstring nullable required

The assignee, if any.

titlestring required
descriptionstring nullable required
descriptionDeferredboolean

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.

statusstring required

The slug of the column the task sits in.

prioritystring required

One of: no-priority, low, medium, high, urgent.

startDatestring date-time nullable required
dueDatestring date-time nullable required
createdAtstring date-time required
workspaceIdstring required

The workspace that owns the task's project.

columnIdstring nullable required

The referenced workflow column; null for virtual statuses and legacy tasks without a column reference.

assigneeNamestring nullable required
assigneeIdstring nullable required

Changes

  • a29fbb97c906Revision changes
    • breaking

      the //////// response's property type changed from object null to no type for status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • breaking

      removed the required property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • info

      added subschema #2 to the //////// response property anyOf list for the response status

  • d1d37e98039bRevision changes
    • info

      added the optional property //////// to the response with the status