API v1
v1
View as Markdown

Get a life event category

GET /api/v1/life-event-categories/{lifeEventCategory}

Retrieve one category: what it is called, where it sits, and how many natures it holds.

The natures themselves are not in here, only how many there are. Ask for the types of the category to read them.

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

Path parameters

Sent as JSON. Anything not listed here is ignored.

lifeEventCategory uuid Required

The id of the category. A path that is not a uuid answers 404 without a query being run.

Returns

A life event category object. A category belonging to somebody else answers 404, which is also what a category that never existed answers, and what a deleted one answers.

data object

The category.

data.type string

Always life_event_category. 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 category is called. A category 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.position integer

Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories 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 category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other.

data.attributes.is_active boolean

Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written.

data.attributes.life_event_type_count integer

How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted.

data.attributes.created_at timestamp

When the category 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.

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-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95 \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95');
Response 200
{
"data": {
"type": "life_event_category",
"id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
"attributes": {
"name": "Relationships and family",
"position": 1,
"is_system": true,
"is_active": true,
"life_event_type_count": 0,
"created_at": 1756252800,
"updated_at": 1756252800
},
"links": {
"self": "https://my.monicahq.com/api/v1/life-event-categories/5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95"
}
}
}

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