Expose field description via the Database API

Hi Softr team,

We’re using the Softr Database API to read and manage our database schema programmatically — it’s a great addition and works well for most of our use cases.

One thing we’re missing: the field description (visible and editable in the UI) is not exposed via the API. When fetching tables and their fields, the response includes name, type, options, required, etc. — but no description property.

We’d love to see this included in both GET and PUT responses so we can:

  • Read existing field descriptions programmatically
  • Write or update field descriptions as part of automated schema documentation workflows
  • Keep our external documentation in sync with the actual database structure

The field description is a natural place to store intent and context for each field. Being able to manage it via API would make it much more useful as a lightweight documentation layer — especially for teams building data-heavy apps where schema clarity matters.

Would love to see this in a future release. Thanks for the great work on the API so far!

Hi Tuur,

Thanks for the feedback.

We just added the field description in the API response. Let us know if it suits your need!

Best

3 Likes

There you go :fire:

Yes, it does work! Thanks so much for getting back to me so quickly.

:folded_hands:t3:

1 Like

Have fun building!

1 Like