reminders

List reminders (v2)

Changed on

Retrieve all reminders for the authenticated user. Supports filtering, sorting, and cursor pagination. With X-Dex-Workspace, where[has_tag] keeps the reminders carrying that workspace tag (another scope's tag matches nothing), and include[tags] or include[reminders_tags] (or the same keys in select) adds each reminder's reminders_tags as { tag_id, tags: { id, name } }, by name. Reminder tags are workspace-only: a Personal request with where[has_tag] is 400 workspace_context_required, and a Personal tag projection gets reminders_tags: []. Returns { data: { reminders: [...], pagination?: { nextCursor, count } } }.

get/v2/reminders/

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/reminders/
  • Auth: HTTP bearer

Query parameters

takeinteger
skipinteger
cursorstring
instring[]
not_instring[]
is_completeboolean
textstring
is_overdueboolean
has_tagstring uuid

Match reminders carrying this single tag id.

orderByunknown
recurrenceboolean
contactsboolean
tagsboolean
reminders_contactsboolean
reminders_tagsboolean
recurrenceboolean
contactsboolean
tagsboolean
idboolean
user_idboolean
textboolean
due_at_dateboolean
due_at_timeboolean
is_completeboolean
email_sentboolean
push_notification_sentboolean
created_atboolean
last_completed_atboolean
next_occurrence_atboolean
workspace_idboolean
assignee_idboolean
reminders_contactsboolean
reminders_tagsboolean
is_overdueboolean

Response

Successful response

Changes

  • 0d35f04ff3edRevision changes
    • info

      added the enum value reminders_tags to the property /propertyNames/ of the query request parameter include

    • info

      added the enum value reminders_tags to the property /propertyNames/ of the query request parameter select

    • info

      added the enum value tags to the property /propertyNames/ of the query request parameter include

    • info

      added the enum value tags to the property /propertyNames/ of the query request parameter select

    • info

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

  • 31b7e538700bRevision changes
    • breaking

      for the query request parameter cursor, the minLength was increased from 0 to 1

    • warning

      for the query request parameter cursor, the maxLength was set to 16384

    • info

      removed the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ from the query request parameter cursor

    • info

      for the query request parameter cursor, the format was generalized from uuid to no format