Baserow

Baserow Field permissions API

The Field permissions API from Baserow — 1 operation(s) for field permissions.

GitHub OpenAPI

Operations 2

GET /api/field-permissions/{field_id}/ #
PATCH /api/field-permissions/{field_id}/ #

Documentation

📖
Documentation
https://baserow.io/docs/apis/rest-api
📖
Authentication
https://baserow.io/user-docs/personal-api-tokens

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/baserow/refs/heads/main/openapi/baserow-field-permissions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/baserow/refs/heads/main/json-schema/baserow-schemas.json

Other Resources

🔗
Redoc
https://api.baserow.io/api/redoc/
🔗
UserDocumentation
https://baserow.io/user-docs/database-api
🔗
OpenAPISpec
https://raw.githubusercontent.com/api-evangelist/baserow/refs/heads/main/openapi/baserow-rest-api-openapi.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/baserow/refs/heads/main/examples/baserow-api-examples.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/baserow-field-permissions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

baserow-field-permissions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Baserow API spec Admin Field permissions API
  version: 2.2.2
  description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api).


    For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).'
  contact:
    url: https://baserow.io/contact
  license:
    name: MIT
    url: https://github.com/baserow/baserow/blob/develop/LICENSE
servers:
- url: https://api.baserow.io
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Field permissions
paths:
  /api/field-permissions/{field_id}/:
    get:
      operationId: get_field_permissions
      description: 'Retrieve the permissions for writing field values and form visibility of a specific field.


        This is a **enterprise** feature.'
      parameters:
      - in: path
        name: field_id
        schema:
          type: integer
        description: The ID of the field to get the permissions for.
        required: true
      tags:
      - Field permissions
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFieldPermissionsResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_FIELD_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
    patch:
      operationId: update_field_permissions
      description: 'Update permissions for writing field values and form visibility for a specific field. This endpoint is used to restrict the ability to modify field values to the roles defined. It also makes it possible to decide if the field can be exposed in forms or not.


        This is a **enterprise** feature.'
      parameters:
      - in: path
        name: field_id
        schema:
          type: integer
        description: The ID of the field to update the permissions for.
        required: true
      tags:
      - Field permissions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUpdateFieldPermissionsRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUpdateFieldPermissionsRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUpdateFieldPermissionsRequest'
      security:
      - UserSource JWT: []
      - JWT: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFieldPermissionsResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_USER_NOT_IN_GROUP
                    - ERROR_REQUEST_BODY_VALIDATION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_FIELD_DOES_NOT_EXIST
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
components:
  schemas:
    RoleEnum:
      enum:
      - ADMIN
      - BUILDER
      - EDITOR
      - NOBODY
      type: string
      description: '* `ADMIN` - Admin

        * `BUILDER` - Builder

        * `EDITOR` - Editor

        * `NOBODY` - Nobody'
    PatchedUpdateFieldPermissionsRequest:
      type: object
      properties:
        role:
          allOf:
          - $ref: '#/components/schemas/RoleEnum'
          description: 'The role required to update the data for this field.


            * `ADMIN` - Admin

            * `BUILDER` - Builder

            * `EDITOR` - Editor

            * `NOBODY` - Nobody'
        allow_in_forms:
          type: boolean
          default: false
          description: 'Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not ''EDITOR''. '
    UpdateFieldPermissionsResponse:
      type: object
      properties:
        role:
          allOf:
          - $ref: '#/components/schemas/RoleEnum'
          description: 'The role required to update the data for this field.


            * `ADMIN` - Admin

            * `BUILDER` - Builder

            * `EDITOR` - Editor

            * `NOBODY` - Nobody'
        allow_in_forms:
          type: boolean
          default: false
          description: '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_id:
          type: integer
          description: The ID of the field whose permissions were updated.
        can_write_values:
          type: boolean
          description: Whether the user can write values to this field.
      required:
      - field_id
      - role
  securitySchemes:
    Database_token:
      type: http
      scheme: bearer
      bearerFormat: Token your_token
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token
    UserSource_JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token