Field permissions

Changed on

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}/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/field-permissions/{field_id}/
  • Auth
    HTTP bearer

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

  • e81714236040Revision changes
    • info

      the endpoint scheme security UserSource JWT was removed from the API

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

  • 51b737b57ec4Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status