List reminders
list_remindersList your own upcoming work-package reminders to check scheduled items, verify existing reminders, or find deferred work packages. Returns reminder time, note, and associated work package.
Instructions
List your own upcoming work-package reminders.
Use this to answer "what have I asked to be reminded about", to check
whether a reminder is already set before creating another one, or to find
the work packages you deferred. Returns the standard list envelope:
items of {id, remind_at, note, work_package, creator} plus
pagination and notes.
Pitfalls. Reminders are personal — this only ever shows the ones the
authenticated account created, never a colleague's, and there is no way
to list someone else's. It only shows reminders that are still
upcoming: once one has fired (or was completed) OpenProject drops it
from this collection, so an empty result does not mean nothing was ever
scheduled. The work package each reminder points at is in
work_package; a reminder is not a work package and its id is not one.
Cross-references: set_work_package_reminder creates, moves or deletes
one; list_notifications shows what OpenProject has actually notified
you about, including fired reminders; get_work_package opens the
ticket a reminder points at.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sums | No | Present only when show_sums was requested. | |
| items | No | The page of results. | |
| notes | No | Degradation markers: capped aggregations, unavailable modules, … | |
| groups | No | Present only when group_by was requested. | |
| pagination | Yes | Total/page/page_size/has_more. |