API v1
v1
View as Markdown

List life event types

GET /api/v1/life-event-types

List every nature your account can record a life event as, grouped the way the picker groups them.

A nature is what a life event was: lunch, a phone call, a medical appointment, a concert. It carries a name, a sentence saying what it covers, a glyph, a tint, and the custom fields a life event of that nature asks for, which are read at their own address rather than here.

The list runs through the categories in the order you arranged them, and through the natures inside each category in the order you arranged those. Retired natures are listed with the rest, because one that is off is meant to be found again and switched back on.

A nature the product supplied reads in the language you ask for. Once somebody renames it, their words stand in every language.

This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.

Query parameters

Sent as JSON. Anything not listed here is ignored.

page integer Optional default: 1

Which page to answer with.

per_page integer Optional default: 25

How many natures one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.

Returns

A page of life event type objects, and how many there are in all.

data array

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

data[] object

One nature.

data[].type string

Always life_event_type. 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.life_event_category_id uuid

The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it.

data[].attributes.name string

What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here.

data[].attributes.description string

A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one.

data[].attributes.icon string

The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone.

data[].attributes.colour string

The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one.

data[].attributes.position integer

Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had.

data[].attributes.is_system boolean

Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other.

data[].attributes.is_active boolean

Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written.

data[].attributes.updates_last_in_touch boolean

Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move.

data[].attributes.created_at timestamp

When the nature was added, as a count of seconds since 1970 rather than a written date.

data[].attributes.updated_at timestamp

When it last changed, as a count of seconds. Equal to created_at until it first changes.

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 natures 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/life-event-types \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/life-event-types', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/life-event-types');
Response 200
{
"data": [
{
"type": "life_event_type",
"id": "c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e",
"attributes": {
"life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
"name": "Call",
"description": null,
"icon": "activity",
"colour": null,
"position": 1,
"is_system": true,
"is_active": true,
"updates_last_in_touch": true,
"created_at": 1756252800,
"updated_at": 1756252800
},
"links": {
"self": "https://my.monicahq.com/api/v1/life-event-types/c3f9a8d1-4e62-4b07-9a35-6d180b2fc74e"
}
},
{
"type": "life_event_type",
"id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
"attributes": {
"life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
"name": "Board game night",
"description": "An evening around a table with a box of cardboard.",
"icon": "activity",
"colour": "bg-sky-500",
"position": 2,
"is_system": false,
"is_active": true,
"updates_last_in_touch": true,
"created_at": 1756339200,
"updated_at": 1756425600
},
"links": {
"self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
}
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 2
}
}

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