List possessions
List the possessions of a vault, sorted by name, each with its type, its location and its values.
A possession belongs to a vault. Its type and its location belong to the account, so the same type and the same location serve every vault.
Sorted by position, the featured possessions come first in their order, followed by every other possession sorted by name.
To go through everything a vault holds, ask for compact possessions with the largest page.
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 vault the possession is kept in, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.
Only the possessions of this possession type.
Only the possessions with this status: owned, ordered, sold, given_away, lost, stolen or thrown_away.
Only the featured possessions when true, only the others when false.
Only the possessions kept at this location or at any location inside it. A location that is not one of the account answers 422.
Either name or position.
When true, each possession carries only its name, its status, the id and name of its type, its location and its current value, which is about a tenth of the full record. Get one possession for the rest.
Which page to answer with.
How many possessions one page holds, between 1 and 100. A number outside the range is brought back into it.
Returns
A page of possession objects, and how many there are in all. A vault with none answers an empty list, and a vault of another account answers 404.
The possessions on this page. An empty list rather than an error when there are none.
One possession.
Always possession. 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.
What the thing is called, such as World’s Best Boss mug.
Free text about the thing, or null.
A serial number, a licence plate or any other reference written on the thing, or null.
Where the thing stands: owned, ordered, sold, given_away, lost, stolen or thrown_away.
How many of the thing there are, at least 1.
Whether the thing is featured, which places it in the order shown first in the vault.
Its place among the featured possessions of the vault, counting from 1, or null when it is not featured.
The kind of thing it is. It is chosen when the possession is added and never changes.
The id of the possession type.
What the type is called.
The colour of the type, as a hexadecimal value.
The icon of the type, one of the glyphs of the catalogue, or null.
Where the thing is kept now, or null when nobody said.
The id of the location.
What the location is called.
What the thing holds for the fields of its type, in the order of the fields: the groups first, then the standalone fields. A field holding nothing is left out.
One value.
The id of the field, which is the key to send when writing its value.
What the field is called.
What the field holds: text, number, date, boolean, select or rating.
The name of the group the field sits in, or null when it stands alone.
The value, as the kind of the field reads it: a string for text, a date written as 2005-03-24 and a choice, a number for a number, an integer from 1 to 5 for a rating, and true or false for a boolean.
How the thing was acquired, read from its acquisition transaction: the earliest purchase, exchange, gift received or inheritance. Each part is null without one. Change it through the transactions, since none of it can be written here.
The type of the acquisition transaction: purchase, exchange, gift_received or inheritance, or null.
Who it came from, or null when the transaction names nobody.
The counterparty of the acquisition transaction, as text.
The day of the acquisition transaction, written as 2005-03-24, or null.
The id of the acquisition transaction, or null.
What it would cost to replace today, or null.
The amount, a decimal with two digits after the point, such as 12.99.
The currency: usd, eur, gbp, cad, aud, chf, jpy, brl, inr or cny.
What the thing is worth now: its latest valuation, else its declared value, else null. Read from its valuations, so it cannot be written here.
The amount, a decimal with two digits after the point, such as 15.00.
The currency of the amount, in lower case. Nothing is ever converted.
Where the amount comes from: valuation or declared_value.
The tags the thing carries, sorted by name.
One tag.
The id of the tag.
What the tag reads.
The colour of the tag, as a hexadecimal value.
When the possession was added, as a count of seconds since 1970.
When it last changed, as a count of seconds.
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 possessions 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.