API v1
v1
View as Markdown

List a vault's reminder dates

GET /api/v1/vaults/{vault}/reminder-occurrences

List the dates of a whole vault, for every contact, group and record in it: what is overdue, what falls today and what comes next. The same dates as the vault dashboard.

Without a category, the dates overdue, today and upcoming are listed together, earliest first, as the vault dashboard lists them. This differs from the dates of one contact, which list every date newest first.

upcoming lists the next date of each active reminder up to days ahead. A date too far off to have been generated yet comes back with a null id, and cannot be answered.

history lists the answered dates, the latest answer first, including those of reminders deleted since.

kind=birthdays keeps the birthdays only. It also lists the birthdays nobody asked to be reminded of, falling today or within days: those come back with the type birthday, a null id, the attributes date, category, subject and age, and a links.contact pointing at the contact. They are never overdue and never in the history, since there is nothing to answer. A birthday held in a sensitive field is left out unless your key may read sensitive fields.

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.

vault string Required

The vault, named either by the readable name it reports as slug or by its id.

category string Optional

One of overdue, today, upcoming or history.

kind string Optional default: all

all for every reminder, birthdays for birthdays only.

days integer Optional default: 7

How many days ahead upcoming reaches, between 1 and 365.

page integer Optional default: 1

Which page to answer with.

per_page integer Optional default: 25

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 of birthdays when they are asked for, and how many there are in all.

data array

The dates on this page. An empty list rather than an error when there are none.

data[] object

One date.

data[].type string

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.

data[].id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data[].attributes object

Everything the record holds.

data[].attributes.reminder uuid

The reminder this date belongs to.

data[].attributes.name string

What the reminder says.

data[].attributes.group object

The group the reminder is about, as an object holding id and name, or null for a reminder about anything else.

data[].attributes.date string

The day it falls on, written as a year, a month and a day, in the reminder's time zone.

data[].attributes.scheduled_for timestamp

The instant it is told at, as a count of seconds since 1970.

data[].attributes.category string

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.

data[].attributes.answer string

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.

data[].attributes.answered_at timestamp

When the answer was given, as a count of seconds, or null.

data[].attributes.cancelled_reason string

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.

data[].attributes.subject object

Who or what the date is about, or null once that record is gone.

data[].attributes.subject.type string

contact, group or entity, an entity being a record of a type you invented.

data[].attributes.subject.id uuid

Its id.

data[].attributes.subject.name string

Its name.

data[].attributes.age integer

For a birthday, the age reached on that day. Null when the year of birth is unknown, for any other date, and for a birthday held in a sensitive field your key may not read.

meta object

Where you are in the collection.

meta.page integer

The page this is, counting from 1.

meta.per_page integer

How many one page holds, which is the size that was asked for once it has been brought into the allowed range.

meta.total integer

How many dates there are in all, not how many are on this page.

data[].links object

Where to find what this date belongs to, and how to answer it.

data[].links.reminder string

The absolute address of the reminder, or null once the reminder was deleted.

data[].links.answer string

The absolute address to answer this date at, or null when it cannot be answered: not generated yet, already answered, cancelled, or about a record of a type you invented.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

GET
curl https://my.monicahq.com/api/v1/vaults/dunder-mifflin/reminder-occurrences?kind=birthdays&days=30 \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/reminder-occurrences?kind=birthdays&days=30', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/reminder-occurrences?kind=birthdays&days=30');
Response 200
{
"data": [
{
"type": "reminder_occurrence",
"id": "a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262",
"attributes": {
"reminder": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
"name": "Ask how the art school application went",
"group": null,
"date": "2026-09-14",
"scheduled_for": 1789390800,
"category": "overdue",
"answer": null,
"answered_at": null,
"cancelled_reason": null,
"subject": {
"type": "contact",
"id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
"name": "Pam Beesly"
},
"age": null
},
"links": {
"reminder": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
"answer": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminder-occurrences/a9d3f6e1-2b47-4c08-8e5a-17f4c0b9d262/answer"
}
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 1
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.