API v1
v1
View as Markdown

Offer or stop offering an entity type

PUT /api/v1/entity-types/{entityType}/activation

Say whether records may still be filed under a kind of object.

This is what a type in use gets instead of a deletion. Stopping one touches nothing already filed under it: every record stays readable and stays editable, and only the button that adds another goes. An account that has finished cataloguing its wine bottles wants the bottles, not the button.

The place the type has in your navigation is kept, so offering it again puts it back where it was rather than at the end.

It has its own endpoint because it is a decision about your account rather than a correction to the wording of the type, and it cannot therefore be made by accident while renaming one. Send the state you want rather than asking for a toggle: sending the same state twice confirms it instead of inverting it.

Parameters

Sent as JSON. Anything not listed here is ignored.

entityType uuid Required

The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.

is_active boolean Required

True to let records be filed under the type again, false to stop new ones being filed. The state you want, not a change: sending the state the type is already in changes nothing and answers with the type.

Returns

The entity type object as it now reads. A type belonging to somebody else answers 404 and is left as it was.

data object

The type.

data.type string

Always entity_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.slug string

How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here.

data.attributes.name_singular string

What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here.

data.attributes.name_plural string

What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages.

data.attributes.description string

What the type is for, up to 65535 characters, or null when nobody said.

data.attributes.icon string

One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word.

data.attributes.colour string

Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it.

data.attributes.position integer

Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had.

data.attributes.is_active boolean

Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable.

data.attributes.entity_count integer

How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted.

data.attributes.created_at timestamp

When the type was declared, 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.

PUT
curl https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64/activation \
-X PUT \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"is_active": false
}'
const response = await fetch('https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64/activation', {
method: 'PUT',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
is_active: false,
}),
})
const data = await response.json()
$response = Http::withToken($token)->put('https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64/activation', [
'is_active' => false,
]);
Response 200
{
"data": {
"type": "entity_type",
"id": "4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64",
"attributes": {
"slug": "animal",
"name_singular": "Animal",
"name_plural": "Animals",
"description": "Every creature the family keeps.",
"icon": "profile",
"colour": "#4f8a49",
"position": 1,
"is_active": true,
"entity_count": 12,
"created_at": 1756252800,
"updated_at": 1756339200
},
"links": {
"self": "https://my.monicahq.com/api/v1/entity-types/4c2b9f10-5e37-4a6d-8b91-0f7c3d2a8e64"
}
}
}

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