List the life event types of a category
List the natures filed under one category, in the order you arranged them.
This is the grouped reading the settings screen shows, one category at a time. Retired natures are listed with the rest, and so are the natures of a retired category, because the list says what is filed where rather than what is currently offered.
The natures are described exactly as the life event types endpoints describe them, so anything you read here can be changed there without asking for it again.
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.
The id of the category. A path that is not a uuid answers 404 without a query being run.
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 type objects, and how many there are in all. A category belonging to somebody else answers 404 rather than an empty list.
The natures on this page. An empty list rather than an error when there are none.
One nature.
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.
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.
The category the nature is filed under, which is the category you asked about.
What the nature is called, in the language you ask for while the product still supplies the wording.
A sentence saying what the nature covers, or null when nobody wrote one.
The glyph drawn beside the nature, or null.
The tint the nature is drawn in, or null.
Where the nature sits inside this category, counting from 1.
Whether the product supplied the nature, which governs deletion and nothing else.
Whether the nature is offered when a life event is recorded.
Whether a life event of this nature sets the Last in touch date of the contacts it is recorded with.
When the nature was added, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
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 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.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.