Restricting API Response Data
Control exactly which fields are returned in your API responses by limiting them to only the fields that have been added to a view.
What you'll learn:
- What the Restrict API Responses setting changes about your API payloads
- Why you might want to enable it
- What to check first so you don't break an existing integration
What This Setting Does
Restrict API Responses is enabled on new apps by default, so that API responses only include fields that have been explicitly added to a view. This applies to record updates via Live App's JavaScript events and view-based API requests. This does not apply to record inserts and POST API requests, which always return all fields in response payloads.
This gives you tighter control over your data in two ways:
- Smaller payloads — responses only carry the data that's actually needed, which can improve performance for apps or integrations making frequent API calls.
- Reduced data exposure — fields you never intended to expose externally (like internal notes or sensitive identifiers) won't appear in API responses just because they exist on the record.
If The Setting Is Off, Do A Check Before You Enable
Tip: If you have existing integrations, scripts, or third-party tools pulling data from your Knack API, they may depend on fields that aren't currently added to any view. Enabling this setting will remove those fields from the response, which can break the integration.
Before turning this on, it's worth auditing:
- Any external integrations or automations that call your Knack API
- Whether the fields they rely on are currently included in a view
Updated about 5 hours ago