List templates
List the templates your account holds, in the order you arranged them.
A template decides what a record shows. It is the definition behind a contact page, or behind everything the account keeps about an Animal. It belongs to your account rather than to one vault, so a template defined once can be used in every vault you hold.
The template itself holds no fields. What it holds is versions, and what a version holds is pages, sections and fields. That split is what keeps records stable while structures change: a record points at a precise version and follows it until somebody moves it deliberately.
Templates that may no longer be applied are listed with the rest, because one that is off is meant to be found again and switched back on. Templates the product supplied are listed too, marked with is_system. A deleted template is never listed, and an account answers with an empty list rather than an error when it holds none.
This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.
Query parameters
Sent as JSON. Anything not listed here is ignored.
Which page to answer with.
How many one page holds, between 1 and 100. A number outside the range is brought back into it rather than refused.
Returns
A page of template objects, and how many there are in all.
The templates on this page. An empty list rather than an error when there are none.
One template.
Always template. 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.
How the template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here.
What the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people.
What the template is for, or null when nobody said.
Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id.
The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints.
Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it.
Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable.
Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in.
The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed.
When the template was created, 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 first changes.
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 templates 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.