List a contact's reminders
List every reminder about one contact, the ones written by hand and the ones reading a date on their page.
A reminder is told on its day, once on each channel you switched on, and never again. Nothing is sent ahead of the day.
Deleted reminders are left out. The answers given to their dates stay, and are read from the dates endpoint.
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.
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 objects, and how many there are in all.
The reminders on this page. An empty list rather than an error when there are none.
One reminder.
Always reminder. 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.
What the reminder says when it comes due.
Where its date comes from: manual when somebody wrote the reminder with a date of its own, field_value when it reads a date on the contact, such as a birthday.
The first date of a manual reminder, written as a year, a month and a day. Null for a reminder that reads a date on the contact.
The date on the contact the reminder reads, as an object holding key, how the field is named in an import or an export, and label, what it is called on the contact. Null for a manual reminder.
The contact the reminder is about.
The id of the contact.
The name of the contact.
The group the reminder is about, as an object holding id and name. Always null here, since these reminders are about a contact. A reminder about a group is read from the group reminders endpoints.
How often it comes back: once, weekly, monthly or yearly.
How many of those between two dates. Every 3 months is monthly with an interval of 3.
The local hour it is told at, on the day itself.
The time zone that hour is read in, fixed when the reminder was made.
Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why.
Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active.
The next date it comes due, or null when nothing is ahead of it.
When the reminder was made, as a count of seconds since 1970.
Where to find this record.
The absolute address this record is read from.
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 reminders there are in all, not how many are on this page.
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.