List the records naming a contact
List the records of any kind, such as an animal, that name one contact in one of their relation fields, by name.
A record is listed when one of its relation fields names the contact, inside a repeating group or not. A value set aside by a change of template does not count. Only records of the contact’s own vault are listed, since a relation never crosses vaults.
This is what the contact’s page shows under Profiles.
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 contact lives in, named either by the readable name it reports as slug or by its id. Both answer.
The contact, named either by its slug or by its id.
Which page to answer with.
How many types one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.
Returns
A page of entity objects, and how many there are in all. A vault or a contact belonging to somebody else answers 404.
The records on this page. An empty list rather than an error when there are none.
One record.
Always entity. 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 record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down.
The kind of record it is. It never changes.
The first letter of the first two words of the name, drawn on the generated avatar.
The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards.
The picture standing in for the record, with its id and url, or null when it is drawn as its initials.
Whether the record was put away. An archived record is still listed.
The exact version of the template the record was written on. A record stays on that version until somebody moves it.
The name of the template that version belongs to.
The values the record holds, in no particular order. A field left empty is not listed.
One value.
The id of the field, which is the key a value is written under when the record is updated.
How the field is named in an import or an export. It is unique inside its section only.
What the field is called on the record.
The kind of field: text, date, select, address and so on.
For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise.
The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden.
Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope.
When the record was written down, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
Where to find this record.
The absolute address this record is read from.
The page of the record in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.
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 records 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.