Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Field permissions

Retrieve the permissions for writing field values and form visibility of a specific field.

This is a enterprise feature.

get/api/field-permissions/{field_id}/

Path parameters

field_idinteger required

The ID of the field to get the permissions for.

Response

role'ADMIN' | 'BUILDER' | 'EDITOR' | 'NOBODY' required
  • ADMIN - Admin
  • BUILDER - Builder
  • EDITOR - Editor
  • NOBODY - Nobody
allow_in_formsboolean

Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not 'EDITOR'.

field_idinteger required

The ID of the field whose permissions were updated.

can_write_valuesboolean

Whether the user can write values to this field.