Sign in
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' | 'CUSTOM' | 'NOBODY' required
  • ADMIN - Admin
  • BUILDER - Builder
  • EDITOR - Editor
  • CUSTOM - Custom
  • 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.

Changes

Changed in 1 of the 6 revisions of this API.11

  • f3396317d93211See the full diff
    • ●

      added the new CUSTOM enum value to the role/allOf[RoleEnum]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the required property subjects to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog