Get a stay
Retrieve one stay of a possession.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Path 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.
The id of the possession. A possession of another vault or of another account answers 404.
The id of the stay. A stay of another possession answers 404.
Returns
A stay object. A vault, a possession or a stay of another account answers 404.
The possession location stay.
Always possession_location_stay. 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.
The id of the location of the account where the possession stayed. Its full path comes from the locations endpoints.
The name of that location, without the locations around it.
The day it arrived, as YYYY-MM-DD, or null when the day is unknown.
The day it left, as YYYY-MM-DD, or null on the stay where it is now.
Whether it is the open stay, where the possession is now. A possession has at most one.
Why it went there, or null.
Anything worth knowing about the stay, or null.
When the stay was recorded, as a count of seconds since 1970.
Where to find this record.
The absolute address this record is read from.
The Locations section of the possession in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.
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.