Get a location
Retrieve one location, its full path and the address that applies to it.
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 id of the location. A location belonging to somebody else answers 404.
Returns
A location object. A location belonging to somebody else answers 404, which is also what a location that never existed answers.
The location.
Always location. 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 location it sits inside, or null at the top level.
What the location is called: a town, a house, a room, a shelf, a box. Two locations may share a name; the path tells them apart.
One emoji shown in place of the default icon, or null for none.
The address written on the location itself, as free text over several lines, or null. Nothing geocodes it.
Every location from the top level down to this one, joined by " › ". It is how a location is named wherever one is chosen.
The address that applies to the location: its own, or else that of the nearest location around it that has one. Null when none of them has an address.
The address, as it was written.
The location the address is written on, which is this one when it has its own.
The name of that location.
How many locations sit directly inside this one. A location holding any cannot be deleted.
When the location was added, as a count of seconds since 1970 rather than a written date.
When it last changed, as a count of seconds. Equal to created_at until it is changed.
Where to find this record.
The absolute address this record is read from.
The screen where the location is edited 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.