API v1
v1
View as Markdown

Create a kind of record

POST /api/v1/entity-types

Declare a kind of object your account wants to keep, when nothing the product ships with fits.

This writes down the noun and nothing else. What one of its records holds is described separately, by a template, so a type can exist for a while with nothing to show. The type goes at the end of your navigation.

Both names are asked for rather than one being made from the other, because a plural derived in English is wrong in most other languages.

The slug is settled here and never rebuilt afterwards. Choose it, and what you send is cleaned the same way a derived one is, so nothing can put a space or an accent in an address. Say nothing, and it is made from the singular name. A slug already taken in your account is refused, and a type you deleted does not release the one it had, so a link that went out cannot later land on something else.

Body parameters

Sent as JSON. Anything not listed here is ignored.

name_singular string Required

What one of these is called. Up to 255 characters. Markup and surrounding blank space are stripped.

name_plural string Required

What several of them are called. Up to 255 characters.

description string Optional

What the type is for. Up to 65535 characters. Absent, empty or null all mean it has none.

icon string Optional default: profile

One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. Absent means profile.

colour string Optional default: #3f5fd0

Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. Absent means #3f5fd0.

is_active boolean Optional default: true

Whether records may be filed under the type straight away. Absent means true. Send false to declare a type before anybody is meant to use it.

slug string Optional

How the type is addressed in the application itself: lower case letters, numbers and single dashes, up to 64 characters. Absent means one made from the singular name. A slug already taken in your account is refused, and that counts the slugs of types you have deleted.

Returns

The new entity type object. Keep its id: every other call here names the type by it.

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.

POST
curl https://my.monicahq.com/api/v1/entity-types \
-X POST \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name_singular": "Animal",
"name_plural": "Animals",
"description": "Every creature the family keeps.",
"slug": "animal"
}'
const response = await fetch('https://my.monicahq.com/api/v1/entity-types', {
method: 'POST',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
name_singular: 'Animal',
name_plural: 'Animals',
description: 'Every creature the family keeps.',
slug: 'animal',
}),
})
const data = await response.json()
$response = Http::withToken($token)->post('https://my.monicahq.com/api/v1/entity-types', [
'name_singular' => 'Animal',
'name_plural' => 'Animals',
'description' => 'Every creature the family keeps.',
'slug' => 'animal',
]);
Response 201
{
"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.