API v1
v1
View as Markdown

List a vault's reminders

GET /api/v1/vaults/{vault}/reminders

List every reminder of a vault about a contact or a group, whatever its date: the ones still producing dates, the ones that stopped, and the ones whose next date is far off.

Each reminder names who it is about: contact holds the contact, group holds the group, and the other one is null. The reminders are listed in the order they were made.

Deleted reminders are left out. While groups are not available to your account, the reminders about a group are left out too.

This lists the reminders themselves. The dates they produce, and what was answered for each, are read from the vault's 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.

vault string Required

The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.

about string Optional

contact keeps the reminders about a contact, group the reminders about a group. Left out, both are listed. Anything else answers 422.

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 objects, and how many there are in all. A vault of another account answers 404.

data array

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

data[] object

One reminder.

data[].type string

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.

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.name string

What the reminder says when it comes due.

data[].attributes.source string

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.

data[].attributes.starts_on string

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.

data[].attributes.field object

The date on the contact the reminder reads, as an object holding key and label. Null for a manual reminder, and always null for a group.

data[].attributes.contact object

The contact the reminder is about, or null for a reminder about a group.

data[].attributes.contact.id uuid

The id of the contact.

data[].attributes.contact.name string

The name of the contact.

data[].attributes.group object

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

data[].attributes.cadence string

How often it comes back: once, weekly, monthly or yearly.

data[].attributes.interval integer

How many of those between two dates. Every 3 months is monthly with an interval of 3.

data[].attributes.time string

The local hour it is told at, on the day itself.

data[].attributes.timezone string

The time zone that hour is read in, fixed when the reminder was made.

data[].attributes.is_active boolean

Whether it still produces dates. A reminder about an archived contact, or one whose date was cleared, stops and says why.

data[].attributes.inactive_reason string

Why it stopped: value_cleared, record_archived, record_deleted or field_removed. Null while it is active.

data[].attributes.next_date string

The next date it comes due, or null when nothing is ahead of it.

data[].attributes.created_at timestamp

When the reminder was made, as a count of seconds since 1970.

data[].links object

Where to find this record.

data[].links.self string

The absolute address this record is read from.

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 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.

GET
curl https://my.monicahq.com/api/v1/vaults/dunder-mifflin/reminders?about=contact \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/reminders?about=contact', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/vaults/dunder-mifflin/reminders?about=contact');
Response 200
{
"data": [
{
"type": "reminder",
"id": "4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13",
"attributes": {
"name": "Ask how the art school application went",
"source": "manual",
"starts_on": "2026-10-14",
"field": null,
"contact": {
"id": "0b6d2f4e-8a13-4c57-9e02-6f3a1d8b7c45",
"name": "Pam Beesly"
},
"group": null,
"cadence": "monthly",
"interval": 1,
"time": "09:00",
"timezone": "America/New_York",
"is_active": true,
"inactive_reason": null,
"next_date": "2026-10-14",
"created_at": 1790380800
},
"links": {
"self": "https://my.monicahq.com/api/v1/vaults/dunder-mifflin/contacts/pam-beesly/reminders/4e7b2c90-3d15-4a86-9f21-8b0c6e5d7a13"
}
}
],
"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.