Browse the tools
Locations
A location is a place where you keep things: a house, a room, a shelf, a box. A location can sit inside another, so they form a tree.
Tools
List the places of the account, such as a house, a room or a shelf, one page at a time. Each one comes before the places inside it, and carries its full path, the address it falls back on and how many places it holds.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many places a page holds: 25 unless asked, 100 at most.
Read one place of the account: its name, the place it sits inside, its emoji, its address, its full path, the address it falls back on and how many places it holds.
-
locationstringrequired - The id of the place, as list-locations gives it.
Add a place to the account, such as a house, a room, a shelf or a box, at the top level or inside another place. Find the place it sits inside with list-locations first. The change is written to the account log.
-
namestringrequired - What the place is called, such as Garage.
-
parent_idstringoptional - The id of the place it sits inside, as list-locations gives it. Left out, it sits at the top level.
-
emojistringoptional - One emoji shown in place of the default icon, such as 🏠.
-
addressstringoptional - The address, as free text over several lines. Left out, the place uses the address of the nearest place around it that has one.
Rename a place of the account, move it inside another place or to the top level, or change its emoji or address. Everything inside it moves with it. The change is written to the account log.
-
locationstringrequired - The id of the place, as list-locations gives it.
-
namestringoptional - The name, such as Garage.
-
parent_idstringoptional - The id of the place to move it inside, as list-locations gives it. Null moves it to the top level.
-
emojistringoptional - One emoji shown in place of the default icon. Null shows the default icon again.
-
addressstringoptional - The address as free text. Null makes the place use the address of the nearest place around it that has one.
Delete a place of the account that holds no other place. One that holds others is refused until they are moved. The change is written to the account log.
-
locationstringrequired - The id of the place, as list-locations gives it.