List a contact's reminder dates
List the dates the reminders about a contact produced, with what was answered for each.
Without a category, every date is listed, newest first, so any date can be looked up: remembered, forgotten, or never answered.
upcoming lists the next date of each active reminder. A date too far off to have been generated yet comes back with a null id, and cannot be answered, which nothing upcoming can be anyway.
history lists the answered dates, the latest answer first, including those of reminders deleted since.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault the contact lives in, named either by the readable name it reports as slug or by its id.
The contact the reminders are about, named either by its slug or by its id. A contact addressed through the wrong vault answers 404.
One of overdue, today, upcoming or history.
Which page to answer with.
How many records one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.
Returns
A page of reminder date objects, and how many there are in all.
The dates on this page. An empty list rather than an error when there are none.
One date.
Always reminder_occurrence. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
The reminder this date belongs to.
What the reminder says.
The group the reminder is about, as an object holding id and name. Always null here, since these dates belong to reminders about a contact.
The day it falls on, written as a year, a month and a day, in the reminder's time zone.
The instant it is told at, as a count of seconds since 1970.
Where it stands while it waits for an answer, read against today in your time zone: upcoming before its day, today on its day, overdue from the day after. Null once it is answered or cancelled.
What you said about this date: remembered or forgotten. Null while nobody answered. No answer is ever filled in for you, and a notification sent or read never counts as one.
When the answer was given, as a count of seconds, or null.
Why the date will not be asked about any more: rule_deleted, record_archived, record_deleted, field_removed, value_cleared, source_changed or rule_changed. Null otherwise. A cancelled date is never counted as forgotten.
Where you are in the collection.
The page this is, counting from 1.
How many one page holds, which is the size that was asked for once it has been brought into the allowed range.
How many dates there are in all, not how many are on this page.
Where to find what this date belongs to.
The absolute address of the reminder, or null once the reminder was deleted.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.