My work

list-deadlines-tool

List your deadlines (or another user's, with the right permission), filtered by status, project, customer or due date.

Returns paginated deadlines for the authenticated user, or for another user if the caller holds kanban::manage_for_others. Each row includes user, project, customer and budget context.

See also: list-projects-tool and get-project-tool to discover deadlines starting from the project side rather than the user.

Inputs

NameTypeRequiredDescription
user_idintegernoDefaults to the authenticated user. A different value requires kanban::manage_for_others.
statusstringnoOne of on-hold, new, active, internal-test, external-test, finished.
is_finishedbooleannoFilter completed/open deadlines.
project_idintegernoLimit to one project.
customer_idintegernoLimit to one customer.
searchstringnoSubstring match on the description (case-insensitive).
due_fromstring (Y-m-d)noInclusive lower bound on the due date.
due_tostring (Y-m-d)noInclusive upper bound on the due date.
limitintegernoPage size, 1–100, default 25.
offsetintegernoNumber of rows to skip, default 0.

Permissions

  • Your own deadlines: kanban::manage_self or kanban::manage_for_others.
  • Another user's deadlines: kanban::manage_for_others.

Example

{
  "is_finished": false,
  "due_from": "2026-05-18",
  "due_to": "2026-05-31"
}

Response

{
  "data": [
    {
      "id": 21,
      "description": "Launch v2",
      "status": "active",
      "is_finished": false,
      "is_billable": true,
      "due_date": "2026-06-01",
      "minutes": 480,
      "duration": "8:00",
      "user": { "id": 4, "name": "Ada Lovelace" },
      "project": {
        "id": 7,
        "title": "ACME website",
        "customer": { "id": 3, "name": "ACME", "code": "ACM" }
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 25,
    "offset": 0,
    "has_more": false
  }
}

Errors

  • An invalid status value returns a validation error.
  • Requesting another user's deadlines without kanban::manage_for_others returns an authorization error.
  • Requesting your own deadlines without kanban::manage_self or kanban::manage_for_others returns an authorization error.

On this page