Browse the tools
Entity types
An entity type is a kind of record that is not a person, such as an animal or a company. Contacts are the kind every vault keeps.
Tools
List the kinds of record the account has defined, beyond contacts, a page at a time.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many entity types a page holds: 25 unless asked, 100 at most.
Read one kind of record the account keeps besides contacts: its names, slug, icon, colour, position, whether new records can be added and how many exist.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.
Create a kind of record the account keeps besides contacts, such as Animal or Wine bottle. The change is written to the account log.
-
name_singularstringrequired - The name of one record, such as Wine bottle.
-
name_pluralstringrequired - The name of several records, such as Wine bottles.
-
descriptionstringoptional - A sentence saying what these records are for.
-
iconstringoptional -
The icon shown next to these records.
One of:
profile,logs,security,preferences,key,device,info,activity,mail,sun,moon,check,pet -
colourstringoptional -
The colour of these records.
One of:
#3f5fd0,#4f8a49,#9a6a24,#9a3f2b,#5d5f96,#1d1d20 -
is_activebooleanoptional - Whether new records can be added. True when left out.
-
slugstringoptional - The part of the URL naming these records, in lowercase letters, numbers and dashes. Derived from the singular name when left out, and fixed once created.
Rename a kind of record or change its description, icon or colour. The slug never changes. The change is written to the account log.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.
-
name_singularstringoptional - The new name of one record.
-
name_pluralstringoptional - The new name of several records.
-
descriptionstringoptional - The new description.
-
iconstringoptional -
The icon shown next to these records.
One of:
profile,logs,security,preferences,key,device,info,activity,mail,sun,moon,check,pet -
colourstringoptional -
The colour of these records.
One of:
#3f5fd0,#4f8a49,#9a6a24,#9a3f2b,#5d5f96,#1d1d20
Switch a kind of record on, so new records of it can be added, or off. Existing records stay. The change is written to the account log.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.
-
is_activebooleanrequired - True to switch the entity type on, false to switch it off.
Move a kind of record to another place in the list. The change is written to the account log.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.
-
positionintegerrequired - Where the entity type goes in the list, counting from 1.
Delete a kind of record. A type still holding records is refused; switch it off instead. The change is written to the account log.
-
entity_typestringrequired - The id of the entity type, as list-entity-types gives it.