The Field rules API from Baserow — 3 operation(s) for field rules.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/baserow:baserow-field-rules-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Baserow API spec Field rules API
version: 2.2.2
description: 'For more information about our REST API, please visit this page.
For more information about our deprecation policy, please visit this page.'
contact:
url: https://baserow.io/contact
license:
name: MIT
url: https://github.com/baserow/baserow/blob/develop/LICENSE
tags:
- name: Field rules
paths:
/api/database/field-rules/{table_id}/:
get:
operationId: get_field_rules
description: Get a list of field rules for the table
parameters:
- in: path
name: table_id
schema:
type: integer
description: The ID of the table to get field rules.
required: true
tags:
- Field rules
security:
- UserSource JWT: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Field_RulesResponseFieldRule'
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
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_TABLE_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: ''
summary: Get field rules
x-summary-source: derived
post:
operationId: create_field_rule
description: Create a field rule for a table
parameters:
- in: path
name: table_id
schema:
type: integer
description: The ID of the table to set a field rule.
required: true
tags:
- Field rules
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Field_RulesRequestFieldRule'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Field_RulesRequestFieldRule'
multipart/form-data:
schema:
$ref: '#/components/schemas/Field_RulesRequestFieldRule'
security:
- UserSource JWT: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Field_RulesResponseFieldRule'
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
- ERROR_RULE_TYPE_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: ''
'404':
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine readable error indicating what went wrong.
enum:
- ERROR_TABLE_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: ''
'409':
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Machine readable error indicating what went wrong.
enum:
- ERROR_RULE_ALREADY_EXISTS
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: ''
summary: Create field rule
x-summary-source: derived
/api/database/field-rules/{table_id}/invalid-rows/:
get:
operationId: get_invalid_rows
description: Get a list of invalid rows
parameters:
- in: path
name: table_id
schema:
type: integer
description: The ID of the table to get a list of invalid row ids.
required: true
tags:
- Field rules
security:
- UserSource JWT: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginationSerializerInvalidRow'
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
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_TABLE_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: ''
summary: Get invalid rows
x-summary-source: derived
/api/database/field-rules/{table_id}/rule/{rule_id}/:
put:
operationId: update_field_rule
description: Update a specific field rule.
parameters:
- in: path
name: rule_id
schema:
type: integer
description: The ID of the rule to update.
required: true
- in: path
name: table_id
schema:
type: integer
description: The ID of the table.
required: true
tags:
- Field rules
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Field_RulesRequestUpdateFieldRule'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Field_RulesRequestUpdateFieldRule'
multipart/form-data:
schema:
$ref: '#/components/schemas/Field_RulesRequestUpdateFieldRule'
security:
- UserSource JWT: []
- JWT: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Field_RulesResponseFieldRule'
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_RULE_DOES_NOT_EXIST
- ERROR_TABLE_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: ''
summary: Update field rule
x-summary-source: derived
delete:
operationId: delete_field_rule
description: Delete a field rule.
parameters:
- in: path
name: rule_id
schema:
type: integer
description: The ID of the rule to delete.
required: true
- in: path
name: table_id
schema:
type: integer
description: The ID of the table.
required: true
tags:
- Field rules
security:
- UserSource JWT: []
- JWT: []
responses:
'204':
description: No response body
'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
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_RULE_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: ''
summary: Delete field rule
x-summary-source: derived
components:
schemas:
DateDependencyResponseFieldRule:
type: object
description: Serializes inbound date dependency configuration. Requires `table` in the context.
properties:
id:
type: integer
readOnly: true
table_id:
type: integer
description: The table that this field rule applies to.
readOnly: true
is_valid:
type: boolean
readOnly: true
description: Tells if the rule is valid in the context of a table. This field is read-only.
error_text:
type:
- string
- 'null'
readOnly: true
description: Stores information about validation error, if it's present. This field is read-only.
is_active:
type: boolean
description: Whether the date dependency is active or not. If set to false, all other values in the payload will be ignored.
type:
allOf:
- $ref: '#/components/schemas/Type908Enum'
description: 'The type of the field rule that must be created.
* `date_dependency` - date_dependency'
start_date_field_id:
type: integer
description: Start date field id
end_date_field_id:
type: integer
description: End date field id
duration_field_id:
type: integer
description: Duration field id
dependency_linkrow_field_id:
type:
- integer
- 'null'
description: Linkrow field id
required:
- error_text
- id
- is_active
- is_valid
- table_id
- type
DateDependencyRequestFieldRule:
type: object
description: Serializes inbound date dependency configuration. Requires `table` in the context.
properties:
is_active:
type: boolean
description: Whether the date dependency is active or not. If set to false, all other values in the payload will be ignored.
type:
allOf:
- $ref: '#/components/schemas/Type908Enum'
description: 'The type of the field rule that must be created.
* `date_dependency` - date_dependency'
start_date_field_id:
type: integer
description: Start date field id
end_date_field_id:
type: integer
description: End date field id
duration_field_id:
type: integer
description: Duration field id
dependency_linkrow_field_id:
type:
- integer
- 'null'
description: Linkrow field id
required:
- is_active
- type
Field_RulesResponseFieldRule:
oneOf:
- $ref: '#/components/schemas/DateDependencyResponseFieldRule'
discriminator:
propertyName: type
mapping:
date_dependency: '#/components/schemas/DateDependencyResponseFieldRule'
Field_RulesRequestFieldRule:
oneOf:
- $ref: '#/components/schemas/DateDependencyRequestFieldRule'
discriminator:
propertyName: type
mapping:
date_dependency: '#/components/schemas/DateDependencyRequestFieldRule'
Type908Enum:
enum:
- date_dependency
type: string
description: '* `date_dependency` - date_dependency'
InvalidRow:
type: object
properties:
id:
type: integer
readOnly: true
required:
- id
DateDependencyRequestUpdateFieldRule:
type: object
description: Serializes inbound date dependency configuration. Requires `table` in the context.
properties:
is_active:
type: boolean
description: Whether the date dependency is active or not. If set to false, all other values in the payload will be ignored.
type:
allOf:
- $ref: '#/components/schemas/Type908Enum'
description: 'The type of the field rule that must be created.
* `date_dependency` - date_dependency'
start_date_field_id:
type: integer
description: Start date field id
end_date_field_id:
type: integer
description: End date field id
duration_field_id:
type: integer
description: Duration field id
dependency_linkrow_field_id:
type:
- integer
- 'null'
description: Linkrow field id
required:
- is_active
- type
PaginationSerializerInvalidRow:
type: object
properties:
count:
type: integer
description: The total amount of results.
next:
type:
- string
- 'null'
format: uri
description: URL to the next page.
previous:
type:
- string
- 'null'
format: uri
description: URL to the previous page.
results:
type: array
items:
$ref: '#/components/schemas/InvalidRow'
required:
- count
- next
- previous
- results
Field_RulesRequestUpdateFieldRule:
oneOf:
- $ref: '#/components/schemas/DateDependencyRequestUpdateFieldRule'
discriminator:
propertyName: type
mapping:
date_dependency: '#/components/schemas/DateDependencyRequestUpdateFieldRule'
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