List life event categories
List the categories your account files its life event natures under, in the order you arranged them.
A category groups the vocabulary in settings and pickers, filters the journal and gives aggregate statistics a level to count at. It never decides which fields a life event carries, who participated, or how it is shared. Moving a nature between categories changes how its life events are grouped, including past ones, and changes no recorded fact.
Every account starts with eight: Relationships and family, Work and education, Health and wellbeing, Home and daily life, Leisure and culture, Travel and experiences, Personal and Other. Other is the fallback, so a nature is never left unclassified. All eight are marked with is_system, which stops them being deleted and nothing else.
Retired categories are listed with the rest, because one that is off is meant to be found again and switched back on.
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.
Which page to answer with.
How many categories 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 category objects, and how many there are in all.
The categories on this page. An empty list rather than an error when there are none.
One category.
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.
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 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.
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.
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.
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.
How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted.
When the category was added, as a count of seconds since 1970 rather than a written date.
When it last changed, as a count of seconds. Equal to created_at until it first changes.
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 categories 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.