Task

A unit of work, optionally inside a project and optionally nested under a parent task.

  • archived_at
    Type: string | nullFormat: date-time
    required

    When the task was archived, or null while it is active.

  • assignee_id
    Type: integer | null
    required

    User id of the assignee, or null when unassigned. Read-only — the create and update endpoints take assignee_member_id instead.

  • assignee_member_id
    Type: integer | null
    required

    Team member id of the assignee, or null when unassigned. This is the value the create and update endpoints accept.

  • assignee_member_name
    Type: string | null
    required

    Name of the assignee, or null when the task is unassigned.

  • company_tags
    Type:
    required

    Tags applied to the task. Only id and name are returned here — list the tags endpoint for a tag's type and color.

    Properties: 2
  • completed_at
    Type: string | nullFormat: date-time
    required

    When the task was marked complete, or null while it is still open.

  • creator_member_id
    Type: integer | null
    required

    Team member id of whoever created the task.

  • due_date
    Type: string | nullFormat: date
    required

    Date the task is due, or null when it is unscheduled.

  • number
    Type: string | null
    required

    Human-readable task reference. null until one has been assigned.

  • parent_task_uuid
    Type: string | null
    required

    uuid of this task's parent when it is a subtask, null for a top-level task.

  • priority
    Type: string | nullenum
    required

    Priority bucket, or null when the task has no priority.

    values
    urgenthighmediumlownull
  • project_id
    Type: integer | null
    required

    Id of the project the task belongs to, or null for a task that stands on its own.

  • project_title
    Type: string | null
    required

    Title of the project the task belongs to, or null.

  • start_date
    Type: string | nullFormat: date
    required

    Date work on the task starts, or null when unset.

  • task_status
    Type: nullable
    required

    The board column the task currently sits in, or null when it has no status.

    Properties: 5
  • time_estimate_in_minutes
    Type: integer | null
    required

    Estimated effort in whole minutes, or null when no estimate is set.

  • title
    Type: string | null
    required

    Task title.

  • url
    Type: string
    required

    Absolute link to the task in the Bonsai app. Resolves to the task on its project board, or to the standalone task list when it belongs to no project.

  • uuid
    Type: string | nullFormat: uuid
    required

    Unique identifier for the task. This is the id every task endpoint takes in its path.

  • billable
    Type: boolean | null

    Whether time logged against this task can be billed to the client. Absent unless the token is allowed to see billing.

  • deal_id
    Type: integer | null

    Id of the deal the task belongs to, or null when it is not attached to a deal. Absent unless the token is allowed to see deals.