Who this is for. Anyone choosing field names for a selector, a filter or a payload, and anyone tempted to write their own API document for a project.
Declared in code, generated from it
Each entity has an API response model in the platform's code. It lists the properties and relations a response can carry, which are exactly the names properties selects and the names a filter can use (where they are stored fields). The documentation of that model is generated from the code, so it is right for the version of the platform it was generated from, and it changes when the code does.
A hand-maintained API document, including one your own team writes for a project, will be wrong within a month as the model changes. Link to the generated pages instead of copying them.
Where to find it
| You need | Go to | Made |
|---|---|---|
| The fields and relations of a record in a response | The model in the Reference, for example Blogs › Blog, “API & Jobs” view | Generated from the code |
| A module's routes | The module under Routes | Generated from the code |
| Every endpoint, with parameters, requests in five languages and real responses | The API reference | Written from the platform team's Postman collection, the route tables and live requests to this site |
| How to use it all, with worked examples | This guide | Written by hand |
The model view answers “what can I select?”. The API reference answers “what do I send, and what comes back?”. Most questions need both: the reference for the request, the model for the field names.
Which to trust first
Trust them in this order:
- A real response from your site. Ask for the field and look. A name that does not exist comes back as an
Error: Getter for property … not foundstring, so the question is settled in one request. - The generated model. It is read from the code.
- The API reference. Its examples are real, but they were captured on a given day and on this site's data.
- This guide. It explains behaviour, and is checked against the platform, but it does not list every field.
If you find a difference, the feedback strip at the foot of every page reaches the people who maintain them.